blob: 7cfd4d14b5612945f69ed33535d6cc439fc99aa0 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080031#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070032#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <sys/resource.h>
34#include <sys/stat.h>
35#include <sys/time.h>
36#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010037#include <signal.h>
38#include <stdarg.h>
39#include <string.h>
40#include <sys/capability.h>
41#include <sys/inotify.h>
42#include <sys/klog.h>
43#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070044#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045
46#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070047#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000048#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <functional>
50#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010051#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070052#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <regex>
54#include <set>
55#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070056#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010057#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070058
Felipe Leme96c2bbb2016-09-26 09:21:21 -070059#include <android-base/file.h>
60#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070061#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080062#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070063#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070064#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010065#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080066#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080067#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000068#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010069#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080070#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070071#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010072#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000073#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080074#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010076#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080077#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010078#include <log/log.h>
Felipe Leme75876a22016-10-27 16:31:27 -070079#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070080#include <private/android_filesystem_config.h>
81#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070083#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080084#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070085#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070086#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080087
Steven Morelandcb7ef822016-11-29 13:20:37 -080088using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080089using ::std::literals::chrono_literals::operator""ms;
90using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080091
Felipe Leme47e9be22016-12-21 15:37:07 -080092// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080093using android::defaultServiceManager;
94using android::Dumpsys;
95using android::INVALID_OPERATION;
96using android::IServiceManager;
97using android::OK;
98using android::sp;
99using android::status_t;
100using android::String16;
101using android::String8;
102using android::TIMED_OUT;
103using android::UNKNOWN_ERROR;
104using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000105using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000106using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800107using android::os::dumpstate::CommandOptions;
108using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -0800109using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -0800110
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100111// Keep in sync with
112// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
113static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
114
115/* Most simple commands have 10 as timeout, so 5 is a good estimate */
116static const int32_t WEIGHT_FILE = 5;
117
118// TODO: temporary variables and functions used during C++ refactoring
119static Dumpstate& ds = Dumpstate::GetInstance();
120static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100121 const CommandOptions& options = CommandOptions::DEFAULT,
122 bool verbose_duration = false) {
123 return ds.RunCommand(title, full_command, options, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100124}
125
126// Reasonable value for max stats.
127static const int STATS_MAX_N_RUNS = 1000;
128static const long STATS_MAX_AVERAGE = 100000;
129
130CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
131
Nandana Duttd2f5f082019-01-18 17:13:52 +0000132typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
133
Colin Crossf45fa6b2012-03-26 12:38:26 -0700134/* read before root is shed */
135static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700136static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000137static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700138
Felipe Leme1d486fe2016-10-14 18:06:47 -0700139// TODO: variables and functions below should be part of dumpstate object
140
Felipe Leme635ca312016-01-05 14:23:02 -0800141static std::set<std::string> mount_points;
142void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800143
Todd Poynor2a83daa2013-11-22 15:44:22 -0800144#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700145#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700146#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800147
Felipe Lemee82a27d2016-01-05 13:35:44 -0800148#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700149#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700150#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700151#define LOGPERSIST_DATA_DIR "/data/misc/logd"
David Brazdild2991962016-06-03 14:40:44 +0100152#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
153#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800154#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900155#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800156#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700157#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800158#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900159#define LINKERCONFIG_DIR "/linkerconfig"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700160
Narayan Kamath8f788292017-05-25 13:20:39 +0100161// TODO(narayan): Since this information has to be kept in sync
162// with tombstoned, we should just put it in a common header.
163//
164// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100165static const std::string TOMBSTONE_DIR = "/data/tombstones/";
166static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
167static const std::string ANR_DIR = "/data/anr/";
168static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700169
Felipe Lemee844a9d2016-09-21 15:01:39 -0700170// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000171
Nandana Dutt5c390032019-03-12 10:52:56 +0000172#define RETURN_IF_USER_DENIED_CONSENT() \
173 if (ds.IsUserConsentDenied()) { \
174 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
175 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
176 }
177
178// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
179// if consent is found to be denied.
180#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
181 RETURN_IF_USER_DENIED_CONSENT(); \
182 func_ptr(__VA_ARGS__); \
183 RETURN_IF_USER_DENIED_CONSENT();
184
Sahana Raof35ed432019-07-12 10:47:52 +0100185static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
186
Nandana Dutt979388e2018-11-30 16:48:55 +0000187namespace android {
188namespace os {
189namespace {
190
191static int Open(std::string path, int flags, mode_t mode = 0) {
192 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
193 if (fd == -1) {
194 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
195 }
196 return fd;
197}
198
Nandana Dutt979388e2018-11-30 16:48:55 +0000199
200static int OpenForRead(std::string path) {
201 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
202}
203
204bool CopyFile(int in_fd, int out_fd) {
205 char buf[4096];
206 ssize_t byte_count;
207 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
208 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
209 return false;
210 }
211 }
212 return (byte_count != -1);
213}
214
215static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000216 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000217
218 // Obtain a handle to the source file.
219 android::base::unique_fd in_fd(OpenForRead(input_file));
220 if (out_fd != -1 && in_fd.get() != -1) {
221 if (CopyFile(in_fd.get(), out_fd)) {
222 return true;
223 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000224 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000225 }
226 return false;
227}
228
Nandana Duttd2f5f082019-01-18 17:13:52 +0000229static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000230 if (unlink(file.c_str())) {
231 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000232 return false;
233 }
234 return true;
235}
Nandana Dutt979388e2018-11-30 16:48:55 +0000236
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000237static bool IsFileEmpty(const std::string& file_path) {
238 std::ifstream file(file_path, std::ios::binary | std::ios::ate);
239 if(file.bad()) {
240 MYLOGE("Cannot open file: %s\n", file_path.c_str());
241 return true;
242 }
243 return file.tellg() <= 0;
244}
245
Nikita Ioffea325a572019-05-16 19:49:47 +0100246int64_t GetModuleMetadataVersion() {
247 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
248 if (binder == nullptr) {
249 MYLOGE("Failed to retrieve package_native service");
250 return 0L;
251 }
252 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
253 std::string package_name;
254 auto status = package_service->getModuleMetadataPackageName(&package_name);
255 if (!status.isOk()) {
256 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
257 return 0L;
258 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100259 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100260 int64_t version_code;
261 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
262 &version_code);
263 if (!status.isOk()) {
264 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
265 return 0L;
266 }
267 return version_code;
268}
269
Nandana Dutt979388e2018-11-30 16:48:55 +0000270} // namespace
271} // namespace os
272} // namespace android
273
Felipe Leme678727a2016-09-21 17:22:11 -0700274static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800275 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800276 long dumpsysTimeoutMs = 0) {
277 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700278}
279static int DumpFile(const std::string& title, const std::string& path) {
280 return ds.DumpFile(title, path);
281}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800282
Felipe Lemee844a9d2016-09-21 15:01:39 -0700283// Relative directory (inside the zip) for all files copied as-is into the bugreport.
284static const std::string ZIP_ROOT_DIR = "FS";
285
Vishnu Naire97d6122018-01-18 13:58:56 -0800286static const std::string kProtoPath = "proto/";
287static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700288static const std::string kDumpstateBoardFiles[] = {
289 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700290 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700291};
292static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
293
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700294static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700295static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700296static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700297static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
298static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700299
Felipe Lemef0292972016-11-22 13:57:05 -0800300static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
301
Narayan Kamath8f788292017-05-25 13:20:39 +0100302/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100303 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
304 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
305 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100306 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700307static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
308 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700309 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100310 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
311
Narayan Kamathbd863722017-06-01 18:50:12 +0100312 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100313
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700314 if (dump_dir == nullptr) {
315 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700316 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700317 }
318
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700319 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100320 struct dirent* entry = nullptr;
321 while ((entry = readdir(dump_dir.get()))) {
322 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100323 continue;
324 }
325
Narayan Kamathbd863722017-06-01 18:50:12 +0100326 const std::string base_name(entry->d_name);
327 if (base_name.find(file_prefix) != 0) {
328 continue;
329 }
330
331 const std::string abs_path = dir_path + base_name;
332 android::base::unique_fd fd(
333 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
334 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700335 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100336 break;
337 }
338
339 struct stat st = {};
340 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700341 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100342 continue;
343 }
344
Narayan Kamath3f31b632018-02-22 19:42:36 +0000345 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100346 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100347 continue;
348 }
349
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700350 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700351 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100352
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700353 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100354}
355
Narayan Kamathbd863722017-06-01 18:50:12 +0100356static bool AddDumps(const std::vector<DumpData>::const_iterator start,
357 const std::vector<DumpData>::const_iterator end,
358 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100359 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100360 for (auto it = start; it != end; ++it) {
361 const std::string& name = it->name;
362 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100363 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100364
365 // Seek to the beginning of the file before dumping any data. A given
366 // DumpData entry might be dumped multiple times in the report.
367 //
368 // For example, the most recent ANR entry is dumped to the body of the
369 // main entry and it also shows up as a separate entry in the bugreport
370 // ZIP file.
371 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
372 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
373 strerror(errno));
374 }
375
Narayan Kamath8f788292017-05-25 13:20:39 +0100376 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800377 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100378 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100379 }
380 } else {
381 dump_file_from_fd(type_name, name.c_str(), fd);
382 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100383 }
384
385 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700386}
387
Felipe Leme635ca312016-01-05 14:23:02 -0800388// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700389void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800390 char path[PATH_MAX];
391
392 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
393 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700394 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800395 char linkname[PATH_MAX];
396 ssize_t r = readlink(path, linkname, PATH_MAX);
397 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800398 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800399 return;
400 }
401 linkname[r] = '\0';
402
403 if (mount_points.find(linkname) == mount_points.end()) {
404 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700405 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700406 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800407 mount_points.insert(linkname);
408 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800409 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800410 }
411 }
412}
413
414void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700415 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700416 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800417 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800418 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700419 for_each_pid(do_mountinfo, nullptr);
420 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800421}
422
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700423static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
424{
425 DIR *d;
426 struct dirent *de;
427 char path[PATH_MAX];
428
429 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700430 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700431 return;
432 }
433
434 while ((de = readdir(d))) {
435 if (de->d_type != DT_LNK) {
436 continue;
437 }
438 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700439 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700440 }
441
442 closedir(d);
443}
444
Mark Salyzyn326842f2015-04-30 09:49:41 -0700445static bool skip_not_stat(const char *path) {
446 static const char stat[] = "/stat";
447 size_t len = strlen(path);
448 if (path[len - 1] == '/') { /* Directory? */
449 return false;
450 }
451 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
452}
453
Felipe Leme4c2d6632016-09-28 14:32:00 -0700454static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800455 return false;
456}
457
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700458unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700459
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800460//
461// stat offsets
462// Name units description
463// ---- ----- -----------
464// read I/Os requests number of read I/Os processed
465#define __STAT_READ_IOS 0
466// read merges requests number of read I/Os merged with in-queue I/O
467#define __STAT_READ_MERGES 1
468// read sectors sectors number of sectors read
469#define __STAT_READ_SECTORS 2
470// read ticks milliseconds total wait time for read requests
471#define __STAT_READ_TICKS 3
472// write I/Os requests number of write I/Os processed
473#define __STAT_WRITE_IOS 4
474// write merges requests number of write I/Os merged with in-queue I/O
475#define __STAT_WRITE_MERGES 5
476// write sectors sectors number of sectors written
477#define __STAT_WRITE_SECTORS 6
478// write ticks milliseconds total wait time for write requests
479#define __STAT_WRITE_TICKS 7
480// in_flight requests number of I/Os currently in flight
481#define __STAT_IN_FLIGHT 8
482// io_ticks milliseconds total time this block device has been active
483#define __STAT_IO_TICKS 9
484// time_in_queue milliseconds total wait time for all requests
485#define __STAT_IN_QUEUE 10
486#define __STAT_NUMBER_FIELD 11
487//
488// read I/Os, write I/Os
489// =====================
490//
491// These values increment when an I/O request completes.
492//
493// read merges, write merges
494// =========================
495//
496// These values increment when an I/O request is merged with an
497// already-queued I/O request.
498//
499// read sectors, write sectors
500// ===========================
501//
502// These values count the number of sectors read from or written to this
503// block device. The "sectors" in question are the standard UNIX 512-byte
504// sectors, not any device- or filesystem-specific block size. The
505// counters are incremented when the I/O completes.
506#define SECTOR_SIZE 512
507//
508// read ticks, write ticks
509// =======================
510//
511// These values count the number of milliseconds that I/O requests have
512// waited on this block device. If there are multiple I/O requests waiting,
513// these values will increase at a rate greater than 1000/second; for
514// example, if 60 read requests wait for an average of 30 ms, the read_ticks
515// field will increase by 60*30 = 1800.
516//
517// in_flight
518// =========
519//
520// This value counts the number of I/O requests that have been issued to
521// the device driver but have not yet completed. It does not include I/O
522// requests that are in the queue but not yet issued to the device driver.
523//
524// io_ticks
525// ========
526//
527// This value counts the number of milliseconds during which the device has
528// had I/O requests queued.
529//
530// time_in_queue
531// =============
532//
533// This value counts the number of milliseconds that I/O requests have waited
534// on this block device. If there are multiple I/O requests waiting, this
535// value will increase as the product of the number of milliseconds times the
536// number of requests waiting (see "read ticks" above for an example).
537#define S_TO_MS 1000
538//
539
Mark Salyzyn326842f2015-04-30 09:49:41 -0700540static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800541 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700542 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700543 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700544 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700545 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700546 getline(&buffer, &i, fp);
547 fclose(fp);
548 if (!buffer) {
549 return -errno;
550 }
551 i = strlen(buffer);
552 while ((i > 0) && (buffer[i - 1] == '\n')) {
553 buffer[--i] = '\0';
554 }
555 if (!*buffer) {
556 free(buffer);
557 return 0;
558 }
559 z = true;
560 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800561 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700562 if (fields[i] != 0) {
563 z = false;
564 }
565 }
566 if (z) { /* never accessed */
567 free(buffer);
568 return 0;
569 }
570
Wei Wang509bb5d2017-06-09 14:42:12 -0700571 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
572 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700573 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700574
575 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
576 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
577 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700578 free(buffer);
579
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800580 if (fields[__STAT_IO_TICKS]) {
581 unsigned long read_perf = 0;
582 unsigned long read_ios = 0;
583 if (fields[__STAT_READ_TICKS]) {
584 unsigned long long divisor = fields[__STAT_READ_TICKS]
585 * fields[__STAT_IO_TICKS];
586 read_perf = ((unsigned long long)SECTOR_SIZE
587 * fields[__STAT_READ_SECTORS]
588 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
589 / divisor;
590 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
591 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
592 / divisor;
593 }
594
595 unsigned long write_perf = 0;
596 unsigned long write_ios = 0;
597 if (fields[__STAT_WRITE_TICKS]) {
598 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
599 * fields[__STAT_IO_TICKS];
600 write_perf = ((unsigned long long)SECTOR_SIZE
601 * fields[__STAT_WRITE_SECTORS]
602 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
603 / divisor;
604 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
605 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
606 / divisor;
607 }
608
609 unsigned queue = (fields[__STAT_IN_QUEUE]
610 + (fields[__STAT_IO_TICKS] >> 1))
611 / fields[__STAT_IO_TICKS];
612
613 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700614 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 -0800615 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700616 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 -0800617 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800618 }
619
620 /* bugreport timeout factor adjustment */
621 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
622 worst_write_perf = write_perf;
623 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700624 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700625 return 0;
626}
627
Yao Chenbe3bbc12018-01-17 16:31:10 -0800628static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
629
630/* timeout in ms to read a list of buffers */
631static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
632 unsigned long timeout_ms = 0;
633 for (const auto& buffer : buffers) {
634 log_id_t id = android_name_to_log_id(buffer.c_str());
635 unsigned long property_size = __android_logger_get_buffer_size(id);
636 /* Engineering margin is ten-fold our guess */
637 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
638 }
639 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700640}
641
Nandana Duttd2f5f082019-01-18 17:13:52 +0000642Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
643}
644
645android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
646 std::lock_guard<std::mutex> lock(lock_);
647 result_ = APPROVED;
648 MYLOGD("User approved consent to share bugreport\n");
649 return android::binder::Status::ok();
650}
651
652android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
653 std::lock_guard<std::mutex> lock(lock_);
654 result_ = DENIED;
655 MYLOGW("User denied consent to share bugreport\n");
656 return android::binder::Status::ok();
657}
658
659UserConsentResult Dumpstate::ConsentCallback::getResult() {
660 std::lock_guard<std::mutex> lock(lock_);
661 return result_;
662}
663
664uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800665 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000666}
667
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700668void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700669 std::string build, fingerprint, radio, bootloader, network;
670 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700671
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700672 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
673 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700674 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
675 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
676 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700677 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700678
Felipe Lemed8b94e52016-12-08 10:21:44 -0800679 printf("========================================================\n");
680 printf("== dumpstate: %s\n", date);
681 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700682
Felipe Lemed8b94e52016-12-08 10:21:44 -0800683 printf("\n");
684 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700685 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800686 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
687 printf("Bootloader: %s\n", bootloader.c_str());
688 printf("Radio: %s\n", radio.c_str());
689 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100690 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
691 if (module_metadata_version != 0) {
692 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
693 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700694
Felipe Lemed8b94e52016-12-08 10:21:44 -0800695 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800696 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800697 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800698 printf("Uptime: ");
699 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
700 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800701 printf("Bugreport format version: %s\n", version_.c_str());
702 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s extra_options=%s\n", id_, pid_,
Nandana Dutt5fb117b2018-09-27 09:23:36 +0100703 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800704 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800705}
706
Felipe Leme24b66ee2016-06-16 10:55:26 -0700707// List of file extensions that can cause a zip file attachment to be rejected by some email
708// service providers.
709static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
710 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
711 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
712 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
713};
714
Vishnu Naire97d6122018-01-18 13:58:56 -0800715status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
716 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700717 if (!IsZipping()) {
718 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
719 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800720 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800721 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700722 std::string valid_name = entry_name;
723
724 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700725 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700726 if (idx != std::string::npos) {
727 std::string extension = entry_name.substr(idx);
728 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
729 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
730 valid_name = entry_name + ".renamed";
731 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
732 }
733 }
734
Felipe Leme6fe9db62016-02-12 09:04:16 -0800735 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
736 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700737 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
738 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700739 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700740 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700741 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800742 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800743 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000744 bool finished_entry = false;
745 auto finish_entry = [this, &finished_entry] {
746 if (!finished_entry) {
747 // This should only be called when we're going to return an earlier error,
748 // which would've been logged. This may imply the file is already corrupt
749 // and any further logging from FinishEntry is more likely to mislead than
750 // not.
751 this->zip_writer_->FinishEntry();
752 }
753 };
754 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800755 auto start = std::chrono::steady_clock::now();
756 auto end = start + timeout;
757 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800758
Felipe Leme770410d2016-01-26 17:07:14 -0800759 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800760 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800761 if (timeout.count() > 0) {
762 // lambda to recalculate the timeout.
763 auto time_left_ms = [end]() {
764 auto now = std::chrono::steady_clock::now();
765 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
766 return std::max(diff.count(), 0LL);
767 };
768
769 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
770 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000771 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
772 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800773 return -errno;
774 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000775 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800776 entry_name.c_str(), strerror(errno), timeout.count());
777 return TIMED_OUT;
778 }
779 }
780
Zach Riggle22200402016-08-18 01:01:24 -0400781 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800782 if (bytes_read == 0) {
783 break;
784 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800785 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800786 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800787 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700788 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800789 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700790 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800791 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800792 }
793 }
794
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700795 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000796 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700797 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700798 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800799 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800800 }
801
Vishnu Naire97d6122018-01-18 13:58:56 -0800802 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800803}
804
Felipe Leme1d486fe2016-10-14 18:06:47 -0700805bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
806 android::base::unique_fd fd(
807 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700808 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800809 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800810 return false;
811 }
812
Vishnu Naire97d6122018-01-18 13:58:56 -0800813 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800814}
815
816/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700817static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800818 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800819}
820
Felipe Leme1d486fe2016-10-14 18:06:47 -0700821void Dumpstate::AddDir(const std::string& dir, bool recursive) {
822 if (!IsZipping()) {
823 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800824 return;
825 }
Felipe Leme678727a2016-09-21 17:22:11 -0700826 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800827 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700828 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800829}
830
Felipe Leme1d486fe2016-10-14 18:06:47 -0700831bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
832 if (!IsZipping()) {
833 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
834 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800835 return false;
836 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800837 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700838 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700839 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700840 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700841 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800842 return false;
843 }
844
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700845 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700846 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700847 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700848 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800849 return false;
850 }
851
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700852 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700853 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700854 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800855 return false;
856 }
857
858 return true;
859}
860
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800861static void DoKmsg() {
862 struct stat st;
863 if (!stat(PSTORE_LAST_KMSG, &st)) {
864 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
865 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
866 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
867 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
868 } else {
869 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
870 DumpFile("LAST KMSG", "/proc/last_kmsg");
871 }
872}
873
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800874static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800875 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800876 RunCommand(
877 "KERNEL LOG",
878 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
879 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
880}
881
Nandana Duttdb379fa2019-10-09 16:54:41 +0100882static void DoSystemLogcat(time_t since) {
883 char since_str[80];
884 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
885
886 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
887 RunCommand("SYSTEM LOG",
888 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
889 since_str},
890 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
891}
892
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800893static void DoRadioLogcat() {
894 unsigned long timeout_ms = logcat_timeout({"radio"});
895 RunCommand(
896 "RADIO LOG",
897 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
898 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
899}
900
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800901static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800902 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800903 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
904 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800905 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100906 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800907 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
908 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800909 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800910 RunCommand(
911 "EVENT LOG",
912 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100913 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800914 timeout_ms = logcat_timeout({"stats"});
915 RunCommand(
916 "STATS LOG",
917 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100918 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800919 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800920
921 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
922
923 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800924 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
925 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800926}
927
Mike Ma5c267872019-08-21 11:31:34 -0700928static void DumpIncidentReport() {
929 if (!ds.IsZipping()) {
930 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
931 return;
932 }
933 DurationReporter duration_reporter("INCIDENT REPORT");
934 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
935 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
936 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
937 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
938 if (fd < 0) {
939 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
940 return;
941 }
942 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
943 bool empty = 0 == lseek(fd, 0, SEEK_END);
944 if (!empty) {
945 // Use a different name from "incident.proto"
946 // /proto/incident.proto is reserved for incident service dump
947 // i.e. metadata for debugging.
948 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
949 }
950 unlink(path.c_str());
951}
952
Jayachandran Ca94c7172017-06-10 15:08:12 -0700953static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700954 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
955 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900956 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700957 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900958 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
959 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
960 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
961 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700962}
963
David Andersond9ba4752018-12-11 18:26:59 -0800964static void DumpDynamicPartitionInfo() {
965 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
966 return;
967 }
968
969 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -0700970 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -0800971}
972
Narayan Kamath8f788292017-05-25 13:20:39 +0100973static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
974 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
975 anr_traces_dir.c_str());
976
977 // If we're here, dump_traces_path will always be a temporary file
978 // (created with mkostemp or similar) that contains dumps taken earlier
979 // on in the process.
980 if (dump_traces_path != nullptr) {
981 if (add_to_zip) {
982 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
983 } else {
984 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
985 dump_traces_path);
986 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
987 }
988
989 const int ret = unlink(dump_traces_path);
990 if (ret == -1) {
991 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
992 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700993 }
994 }
995
Narayan Kamathbd863722017-06-01 18:50:12 +0100996 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700997 if (ds.anr_data_.size() > 0) {
998 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100999 "VM TRACES AT LAST ANR", add_to_zip);
1000
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001001 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1002 // it will be present in the body of the main entry if |add_to_zip| == false.
1003 //
1004 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001005 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001006 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001007 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001008 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1009 }
1010}
1011
1012static void AddAnrTraceFiles() {
1013 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1014
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001015 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001016
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001017 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001018
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001019 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1020
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001021 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001022 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001023 int i = 0;
1024 while (true) {
1025 const std::string slow_trace_path =
1026 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1027 if (stat(slow_trace_path.c_str(), &st)) {
1028 // No traces file at this index, done with the files.
1029 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001030 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001031 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1032 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001033 }
1034}
1035
Wei Wang509bb5d2017-06-09 14:42:12 -07001036static void DumpBlockStatFiles() {
1037 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001038
Wei Wang1dc1ef52017-06-12 11:28:37 -07001039 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1040
1041 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001042 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1043 return;
1044 }
1045
1046 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001047 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001048 if ((d->d_name[0] == '.')
1049 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1050 || (d->d_name[1] == '\0'))) {
1051 continue;
1052 }
1053 const std::string new_path =
1054 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1055 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1056 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1057 printf("\n");
1058 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001059 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001060}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001061
1062static void DumpPacketStats() {
1063 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1064 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1065 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1066 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1067 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1068}
1069
1070static void DumpIpAddrAndRules() {
1071 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1072 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1073 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1074 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1075 RunCommand("IP RULES", {"ip", "rule", "show"});
1076 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1077}
1078
Nandana Dutt5c390032019-03-12 10:52:56 +00001079static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1080 std::chrono::milliseconds timeout,
1081 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001082 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001083 sp<android::IServiceManager> sm = defaultServiceManager();
1084 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001085 Vector<String16> args;
1086 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001087 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1088 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001089 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001090 std::string path(title);
1091 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001092 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001093 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001094 if (status == OK) {
1095 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1096 std::chrono::duration<double> elapsed_seconds;
1097 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1098 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001099 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1100 bool dump_complete = (status == OK);
1101 dumpsys.stopDumpThread(dump_complete);
1102 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001103
1104 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1105 std::chrono::steady_clock::now() - start);
1106 if (elapsed_duration > timeout) {
1107 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1108 elapsed_duration.count());
1109 break;
1110 }
1111 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001112 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001113}
1114
Vishnu Nair64afc022018-02-01 15:29:34 -08001115static void RunDumpsysText(const std::string& title, int priority,
1116 std::chrono::milliseconds timeout,
1117 std::chrono::milliseconds service_timeout) {
1118 DurationReporter duration_reporter(title);
1119 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1120 fsync(STDOUT_FILENO);
1121 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1122}
1123
1124/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001125static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1126 std::chrono::milliseconds timeout,
1127 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001128 DurationReporter duration_reporter(title);
1129 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1130 fsync(STDOUT_FILENO);
1131 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1132 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001133
1134 RETURN_IF_USER_DENIED_CONSENT();
1135
1136 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1137 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001138}
1139
Nandana Dutt5c390032019-03-12 10:52:56 +00001140static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1141 std::chrono::milliseconds timeout,
1142 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001143 if (!ds.IsZipping()) {
1144 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001145 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001146 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001147 sp<android::IServiceManager> sm = defaultServiceManager();
1148 Dumpsys dumpsys(sm.get());
1149 Vector<String16> args;
1150 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1151 DurationReporter duration_reporter(title);
1152
1153 auto start = std::chrono::steady_clock::now();
1154 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1155 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001156 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001157 std::string path(kProtoPath);
1158 path.append(String8(service).c_str());
1159 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1160 path.append("_CRITICAL");
1161 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1162 path.append("_HIGH");
1163 }
1164 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001165 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001166 if (status == OK) {
1167 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1168 bool dumpTerminated = (status == OK);
1169 dumpsys.stopDumpThread(dumpTerminated);
1170 }
1171 ZipWriter::FileEntry file_entry;
1172 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001173
1174 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1175 std::chrono::steady_clock::now() - start);
1176 if (elapsed_duration > timeout) {
1177 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1178 elapsed_duration.count());
1179 break;
1180 }
1181 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001182 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001183}
1184
Nandana Dutta7db6342018-11-21 14:53:34 +00001185// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001186static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001187 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1188 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001189
1190 RETURN_IF_USER_DENIED_CONSENT();
1191
1192 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1193 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001194}
1195
1196// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001197static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001198 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1199 // high priority. Reduce timeout once they are able to dump in a shorter time or
1200 // moved to a parallel task.
1201 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1202 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001203
1204 RETURN_IF_USER_DENIED_CONSENT();
1205
1206 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1207 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001208}
1209
1210// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001211static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001212 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001213
1214 RETURN_IF_USER_DENIED_CONSENT();
1215
1216 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1217 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001218}
1219
Steven Moreland44cd9482018-01-04 16:24:13 -08001220static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001221 if (!ds.IsZipping()) {
1222 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1223 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1224 return;
1225 }
1226 DurationReporter duration_reporter("DUMP HALS");
1227 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001228 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001229
Steven Moreland44cd9482018-01-04 16:24:13 -08001230 using android::hidl::manager::V1_0::IServiceManager;
1231 using android::hardware::defaultServiceManager;
1232
1233 sp<IServiceManager> sm = defaultServiceManager();
1234 if (sm == nullptr) {
1235 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1236 return;
1237 }
1238
1239 auto ret = sm->list([&](const auto& interfaces) {
1240 for (const std::string& interface : interfaces) {
1241 std::string cleanName = interface;
1242 std::replace_if(cleanName.begin(),
1243 cleanName.end(),
1244 [](char c) {
1245 return !isalnum(c) &&
1246 std::string("@-_:.").find(c) == std::string::npos;
1247 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001248 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001249
1250 {
1251 auto fd = android::base::unique_fd(
1252 TEMP_FAILURE_RETRY(open(path.c_str(),
1253 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1254 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1255 if (fd < 0) {
1256 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1257 continue;
1258 }
1259 RunCommandToFd(fd,
1260 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001261 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001262 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1263
1264 bool empty = 0 == lseek(fd, 0, SEEK_END);
1265 if (!empty) {
1266 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1267 }
1268 }
1269
1270 unlink(path.c_str());
1271 }
1272 });
1273
1274 if (!ret.isOk()) {
1275 MYLOGE("Could not list hals from hwservicemanager.\n");
1276 }
1277}
1278
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001279static void DumpExternalFragmentationInfo() {
1280 struct stat st;
1281 if (stat("/proc/buddyinfo", &st) != 0) {
1282 MYLOGE("Unable to dump external fragmentation info\n");
1283 return;
1284 }
1285
1286 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1287 std::ifstream ifs("/proc/buddyinfo");
1288 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1289 for (std::string line; std::getline(ifs, line);) {
1290 std::smatch match_results;
1291 if (std::regex_match(line, match_results, unusable_index_regex)) {
1292 std::stringstream free_pages(std::string{match_results[3]});
1293 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1294 std::istream_iterator<int>());
1295
1296 int total_free_pages = 0;
1297 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1298 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1299 }
1300
1301 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1302 match_results[2].str().c_str());
1303
1304 int usable_free_pages = total_free_pages;
1305 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1306 auto unusable_index = (total_free_pages - usable_free_pages) /
1307 static_cast<double>(total_free_pages);
1308 printf(" %5.3f", unusable_index);
1309 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1310 }
1311
1312 printf("\n");
1313 }
1314 }
1315 printf("\n");
1316}
1317
Nandana Dutt5c390032019-03-12 10:52:56 +00001318// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1319// via the consent they are shown. Ignores other errors that occur while running various
1320// commands. The consent checking is currently done around long running tasks, which happen to
1321// be distributed fairly evenly throughout the function.
1322static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001323 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001324
Nandana Dutt5c390032019-03-12 10:52:56 +00001325 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1326 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1327 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001328 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001329 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001330 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001331 DumpFile("MEMORY INFO", "/proc/meminfo");
1332 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001333 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001334
1335 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1336
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001337 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1338 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1339 DumpFile("SLAB INFO", "/proc/slabinfo");
1340 DumpFile("ZONEINFO", "/proc/zoneinfo");
1341 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1342 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001343 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001344
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001345 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1346 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001347
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001348 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001349 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001350
1351 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1352 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001353
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001354 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001355
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001356 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001357 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001358 struct stat s;
1359 if (stat("/proc/modules", &s) != 0) {
1360 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1361 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001362 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001363 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001364
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001365 if (__android_logger_property_get_bool(
1366 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1367 DoKernelLogcat();
1368 } else {
1369 do_dmesg();
1370 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001371
Felipe Lemef0292972016-11-22 13:57:05 -08001372 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001373
1374 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1375
Jeff Brown1dc94e32014-09-11 14:15:27 -07001376 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001377 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001378
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001379 /* Dump Bluetooth HCI logs */
1380 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001381
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001382 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001383 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001384 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001385 }
1386
Felipe Lemee184f662016-10-27 10:04:47 -07001387 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001388
Narayan Kamath8f788292017-05-25 13:20:39 +01001389 // NOTE: tombstones are always added as separate entries in the zip archive
1390 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001391 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001392 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001393 if (!tombstones_dumped) {
1394 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001395 }
1396
Jayachandran Ca94c7172017-06-10 15:08:12 -07001397 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001398
Chenbo Feng276a3b62018-08-07 11:44:49 -07001399 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1400
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001401 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001402
Jayachandran Ca94c7172017-06-10 15:08:12 -07001403 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001404
1405 dump_route_tables();
1406
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001407 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1408 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1409 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001410
Nandana Dutt5c390032019-03-12 10:52:56 +00001411 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001412
Elliott Hughes23ccc622017-02-28 10:14:22 -08001413 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001414
Jin Qianf334d662017-10-10 14:41:37 -07001415 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001416
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001417 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001418
Colin Crossf45fa6b2012-03-26 12:38:26 -07001419 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001420 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1421 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1422 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1423 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1424 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001425
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001426 /* Add window and surface trace files. */
1427 if (!PropertiesHelper::IsUserBuild()) {
1428 ds.AddDir(WMTRACE_DATA_DIR, false);
1429 }
1430
Nandana Dutt5c390032019-03-12 10:52:56 +00001431 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001432
Steven Moreland7440ddb2016-12-15 16:13:39 -08001433 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001434 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1435 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001436 // su does not exist on user builds, so try running without it.
1437 // This way any implementations of vril-dump that do not require
1438 // root can run on user builds.
1439 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001440 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001441 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001442 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001443 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001444 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001445 }
1446
Felipe Lemed8b94e52016-12-08 10:21:44 -08001447 printf("========================================================\n");
1448 printf("== Android Framework Services\n");
1449 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001450
Nandana Dutt5c390032019-03-12 10:52:56 +00001451 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001452
Felipe Lemed8b94e52016-12-08 10:21:44 -08001453 printf("========================================================\n");
1454 printf("== Checkins\n");
1455 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001456
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001457 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001458
1459 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1460
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001461 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1462 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1463 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1464 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001465
Felipe Lemed8b94e52016-12-08 10:21:44 -08001466 printf("========================================================\n");
1467 printf("== Running Application Activities\n");
1468 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001469
Makoto Onuki60780982018-04-16 15:34:00 -07001470 // The following dumpsys internally collects output from running apps, so it can take a long
1471 // time. So let's extend the timeout.
1472
1473 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1474
1475 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001476
Felipe Lemed8b94e52016-12-08 10:21:44 -08001477 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001478 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001479 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001480
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001481 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001482 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001483
Felipe Lemed8b94e52016-12-08 10:21:44 -08001484 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001485 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001486 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001487
Makoto Onuki60780982018-04-16 15:34:00 -07001488 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1489 DUMPSYS_COMPONENTS_OPTIONS);
1490
1491 printf("========================================================\n");
1492 printf("== Running Application Providers (platform)\n");
1493 printf("========================================================\n");
1494
1495 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1496 DUMPSYS_COMPONENTS_OPTIONS);
1497
1498 printf("========================================================\n");
1499 printf("== Running Application Providers (non-platform)\n");
1500 printf("========================================================\n");
1501
1502 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1503 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001504
Adrian Roos8b397ab2017-04-04 16:35:44 -07001505 printf("========================================================\n");
1506 printf("== Dropbox crashes\n");
1507 printf("========================================================\n");
1508
1509 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1510 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1511
Felipe Lemed8b94e52016-12-08 10:21:44 -08001512 printf("========================================================\n");
1513 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1514 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1515 printf("========================================================\n");
1516 printf("== dumpstate: done (id %d)\n", ds.id_);
1517 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001518
1519 printf("========================================================\n");
1520 printf("== Obtaining statsd metadata\n");
1521 printf("========================================================\n");
1522 // This differs from the usual dumpsys stats, which is the stats report data.
1523 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001524
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001525 // Add linker configuration directory
1526 ds.AddDir(LINKERCONFIG_DIR, true);
1527
Mike Ma5c267872019-08-21 11:31:34 -07001528 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1529
Nandana Dutt5c390032019-03-12 10:52:56 +00001530 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001531}
1532
Nandana Dutt5c390032019-03-12 10:52:56 +00001533/*
1534 * Dumps state for the default case; drops root after it's no longer necessary.
1535 *
1536 * Returns RunStatus::OK if everything went fine.
1537 * Returns RunStatus::ERROR if there was an error.
1538 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1539 * with the caller.
1540 */
1541static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001542 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001543 // keep the system stats as close to its initial state as possible.
Nandana Dutt5c390032019-03-12 10:52:56 +00001544 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001545
Nandana Duttdb379fa2019-10-09 16:54:41 +01001546 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1547 // buffer.
1548 DoLogcat();
1549 // Capture timestamp after first logcat to use in next logcat
1550 time_t logcat_ts = time(nullptr);
1551
Nandana Dutt4be45d12018-09-26 15:04:23 +01001552 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001553 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001554
1555 /* Run some operations that require root. */
1556 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1557 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1558
1559 ds.AddDir(RECOVERY_DIR, true);
1560 ds.AddDir(RECOVERY_DATA_DIR, true);
1561 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1562 ds.AddDir(LOGPERSIST_DATA_DIR, false);
Yifan Hong0efa7972020-02-03 16:45:02 -08001563 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001564 if (!PropertiesHelper::IsUserBuild()) {
1565 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1566 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1567 }
1568 add_mountinfo();
1569 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001570 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001571 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001572
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001573 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001574 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1575
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001576 // Dump IPsec stats. No keys are exposed here.
1577 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1578
Nandana Dutt4be45d12018-09-26 15:04:23 +01001579 // Run ss as root so we can see socket marks.
1580 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1581
1582 // Run iotop as root to show top 100 IO threads
1583 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1584
Erick Reyese68df822019-02-11 14:46:36 -08001585 // Gather shared memory buffer info if the product implements it
1586 struct stat st;
1587 if (!stat("/product/bin/dmabuf_dump", &st)) {
1588 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1589 }
1590
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001591 DumpFile("PSI cpu", "/proc/pressure/cpu");
1592 DumpFile("PSI memory", "/proc/pressure/memory");
1593 DumpFile("PSI io", "/proc/pressure/io");
1594
Nandana Dutt4be45d12018-09-26 15:04:23 +01001595 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001596 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001597 }
1598
Nandana Dutt5c390032019-03-12 10:52:56 +00001599 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001600 Dumpstate::RunStatus status = dumpstate();
1601 // Capture logcat since the last time we did it.
1602 DoSystemLogcat(logcat_ts);
1603 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001604}
1605
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001606// This method collects common dumpsys for telephony and wifi. Typically, wifi
1607// reports are fine to include all information, but telephony reports on user
1608// builds need to strip some content (see DumpstateTelephonyOnly).
1609static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001610 DumpIpTablesAsRoot();
1611
Jayachandran C69968272019-07-08 09:46:05 -07001612 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1613
Jayachandran Ca94c7172017-06-10 15:08:12 -07001614 if (!DropRootUser()) {
1615 return;
1616 }
1617
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001618 // We need to be picky about some stuff for telephony reports on user builds.
1619 if (!include_sensitive_info) {
1620 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1621 DoRadioLogcat();
1622 } else {
1623 // Contains various system properties and process startup info.
1624 do_dmesg();
1625 // Logs other than the radio buffer may contain package/component names and potential PII.
1626 DoLogcat();
1627 // Too broad for connectivity problems.
1628 DoKmsg();
1629 // Contains unrelated hardware info (camera, NFC, biometrics, ...).
1630 DumpHals();
1631 }
1632
Jayachandran Ca94c7172017-06-10 15:08:12 -07001633 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001634 DumpIpAddrAndRules();
1635 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001636 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1637 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001638}
1639
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001640// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1641// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1642// for what can be included on user builds: all reported information MUST directly relate to
1643// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1644// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1645// names are not), and MUST NOT contain logs of user application traffic.
1646// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
mukesh agrawal253dad42018-01-23 21:59:59 -08001647static void DumpstateTelephonyOnly() {
1648 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001649
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001650 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001651
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001652 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001653
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001654 DumpstateRadioCommon(include_sensitive_info);
1655
1656 if (include_sensitive_info) {
1657 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1658 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1659 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1660 // way.
1661 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1662 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001663
1664 printf("========================================================\n");
1665 printf("== Android Framework Services\n");
1666 printf("========================================================\n");
1667
Vishnu Nair652cc802017-11-30 15:18:30 -08001668 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1669 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001670 // TODO(b/146521742) build out an argument to include bound services here for user builds
Vishnu Nair652cc802017-11-30 15:18:30 -08001671 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1672 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001673 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1674 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001675 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1676 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001677 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001678 if (include_sensitive_info) {
1679 // Contains raw IP addresses, omit from reports on user builds.
1680 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1681 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1682 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1683 SEC_TO_MSEC(10));
1684 // Contains package/component names, omit from reports on user builds.
1685 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1686 SEC_TO_MSEC(10));
1687 // Contains package names, but should be relatively simple to remove them (also contains
1688 // UIDs already), omit from reports on user builds.
1689 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1690 SEC_TO_MSEC(10));
1691 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001692
1693 printf("========================================================\n");
1694 printf("== Running Application Services\n");
1695 printf("========================================================\n");
1696
1697 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1698
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001699 if (include_sensitive_info) {
1700 printf("========================================================\n");
1701 printf("== Running Application Services (non-platform)\n");
1702 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001703
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001704 // Contains package/component names and potential PII, omit from reports on user builds.
1705 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1706 // carrier_config dumpsys instead.
1707 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1708 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001709
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001710 printf("========================================================\n");
1711 printf("== Checkins\n");
1712 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001713
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001714 // Contains package/component names, omit from reports on user builds.
1715 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1716 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001717
1718 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001719 printf("== dumpstate: done (id %d)\n", ds.id_);
1720 printf("========================================================\n");
1721}
1722
mukesh agrawal253dad42018-01-23 21:59:59 -08001723// This method collects dumpsys for wifi debugging only
1724static void DumpstateWifiOnly() {
1725 DurationReporter duration_reporter("DUMPSTATE");
1726
1727 DumpstateRadioCommon();
1728
1729 printf("========================================================\n");
1730 printf("== Android Framework Services\n");
1731 printf("========================================================\n");
1732
1733 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1734 SEC_TO_MSEC(10));
1735 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1736 SEC_TO_MSEC(10));
1737
1738 printf("========================================================\n");
1739 printf("== dumpstate: done (id %d)\n", ds.id_);
1740 printf("========================================================\n");
1741}
1742
Nandana Duttcf419a72019-03-14 10:40:17 +00001743Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001744 DurationReporter duration_reporter("DUMP TRACES");
1745
1746 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1747 const size_t buf_size = temp_file_pattern.length() + 1;
1748 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1749 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1750
1751 // Create a new, empty file to receive all trace dumps.
1752 //
1753 // TODO: This can be simplified once we remove support for the old style
1754 // dumps. We can have a file descriptor passed in to dump_traces instead
1755 // of creating a file, closing it and then reopening it again.
1756 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1757 if (fd < 0) {
1758 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001759 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001760 }
1761
1762 // Nobody should have access to this temporary file except dumpstate, but we
1763 // temporarily grant 'read' to 'others' here because this file is created
1764 // when tombstoned is still running as root, but dumped after dropping. This
1765 // can go away once support for old style dumping has.
1766 const int chmod_ret = fchmod(fd, 0666);
1767 if (chmod_ret < 0) {
1768 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001769 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001770 }
1771
1772 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1773 if (proc.get() == nullptr) {
1774 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001775 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001776 }
1777
1778 // Number of times process dumping has timed out. If we encounter too many
1779 // failures, we'll give up.
1780 int timeout_failures = 0;
1781 bool dalvik_found = false;
1782
1783 const std::set<int> hal_pids = get_interesting_hal_pids();
1784
1785 struct dirent* d;
1786 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001787 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001788 int pid = atoi(d->d_name);
1789 if (pid <= 0) {
1790 continue;
1791 }
1792
1793 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1794 std::string exe;
1795 if (!android::base::Readlink(link_name, &exe)) {
1796 continue;
1797 }
1798
1799 bool is_java_process;
1800 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1801 // Don't bother dumping backtraces for the zygote.
1802 if (IsZygote(pid)) {
1803 continue;
1804 }
1805
1806 dalvik_found = true;
1807 is_java_process = true;
1808 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1809 is_java_process = false;
1810 } else {
1811 // Probably a native process we don't care about, continue.
1812 continue;
1813 }
1814
1815 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1816 if (timeout_failures == 3) {
1817 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1818 break;
1819 }
1820
1821 const uint64_t start = Nanotime();
1822 const int ret = dump_backtrace_to_file_timeout(
1823 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1824 is_java_process ? 5 : 20, fd);
1825
1826 if (ret == -1) {
1827 // For consistency, the header and footer to this message match those
1828 // dumped by debuggerd in the success case.
1829 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1830 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1831 dprintf(fd, "---- end %d ----", pid);
1832 timeout_failures++;
1833 continue;
1834 }
1835
1836 // We've successfully dumped stack traces, reset the failure count
1837 // and write a summary of the elapsed time to the file and continue with the
1838 // next process.
1839 timeout_failures = 0;
1840
1841 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1842 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1843 }
1844
1845 if (!dalvik_found) {
1846 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1847 }
1848
Nandana Duttcf419a72019-03-14 10:40:17 +00001849 *path = file_name_buf.release();
1850 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001851}
1852
Felipe Leme6f674ae2016-11-18 17:10:33 -08001853void Dumpstate::DumpstateBoard() {
1854 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001855 printf("========================================================\n");
1856 printf("== Board\n");
1857 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001858
Felipe Leme6f674ae2016-11-18 17:10:33 -08001859 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001860 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001861 return;
1862 }
1863
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001864 std::vector<std::string> paths;
1865 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001866 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001867 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1868 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001869 remover.emplace_back(android::base::make_scope_guard(
1870 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001871 }
Jie Song9fbfad02017-06-20 16:29:42 -07001872
Wei Wang587eac92018-04-05 12:17:20 -07001873 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1874 if (dumpstate_device == nullptr) {
1875 MYLOGE("No IDumpstateDevice implementation\n");
1876 return;
1877 }
1878
1879 using ScopedNativeHandle =
1880 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1881 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1882 [](native_handle_t* handle) {
1883 native_handle_close(handle);
1884 native_handle_delete(handle);
1885 });
1886 if (handle == nullptr) {
1887 MYLOGE("Could not create native_handle\n");
1888 return;
1889 }
1890
Nandana Dutt5c390032019-03-12 10:52:56 +00001891 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001892 for (size_t i = 0; i < paths.size(); i++) {
1893 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1894
1895 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1896 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1897 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1898 if (fd < 0) {
1899 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1900 return;
1901 }
1902 handle.get()->data[i] = fd.release();
1903 }
1904
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001905 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001906 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1907 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1908 // and grab whatever dumped
1909 std::packaged_task<bool()>
1910 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001911 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1912 if (!status.isOk()) {
1913 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001914 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001915 }
Wei Wang587eac92018-04-05 12:17:20 -07001916 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001917 });
Wei Wang587eac92018-04-05 12:17:20 -07001918
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001919 auto result = dumpstate_task.get_future();
1920 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001921
1922 constexpr size_t timeout_sec = 30;
1923 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1924 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1925 if (!android::base::SetProperty("ctl.interface_restart",
1926 android::base::StringPrintf("%s/default",
1927 IDumpstateDevice::descriptor))) {
1928 MYLOGE("Couldn't restart dumpstate HAL\n");
1929 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001930 }
Wei Wang587eac92018-04-05 12:17:20 -07001931 // Wait some time for init to kill dumpstate vendor HAL
1932 constexpr size_t killing_timeout_sec = 10;
1933 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1934 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1935 "there might be racing in content\n", killing_timeout_sec);
1936 }
1937
1938 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1939 for (size_t i = 0; i < paths.size(); i++) {
1940 struct stat s;
1941 if (fstat(handle.get()->data[i], &s) == -1) {
1942 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1943 strerror(errno));
1944 file_sizes[i] = -1;
1945 continue;
1946 }
1947 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001948 }
1949
1950 for (size_t i = 0; i < paths.size(); i++) {
1951 if (file_sizes[i] == -1) {
1952 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001953 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001954 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001955 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001956 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001957 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001958 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001959 }
1960
Felipe Lemed8b94e52016-12-08 10:21:44 -08001961 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001962}
1963
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001964static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001965 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001966 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001967 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1968 " -h: display this help message\n"
1969 " -b: play sound file instead of vibrate, at beginning of job\n"
1970 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001971 " -d: append date to filename\n"
1972 " -p: capture screenshot to filename.png\n"
1973 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001974 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001975 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001976 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001977 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001978 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001979 "progress (requires -B)\n"
1980 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001981 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001982 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001983 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001984}
1985
Wei Liuf87959e2016-08-26 14:51:42 -07001986static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001987 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001988}
1989
Felipe Leme1d486fe2016-10-14 18:06:47 -07001990bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001991 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001992 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001993 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001994 // Final timestamp
1995 char date[80];
1996 time_t the_real_now_please_stand_up = time(nullptr);
1997 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001998 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001999 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002000
Felipe Leme9a523ae2016-10-20 15:10:33 -07002001 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002002 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002003 return false;
2004 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002005 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002006 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002007 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002008 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002009
Felipe Leme0f3fb202016-06-10 17:10:53 -07002010 // Add log file (which contains stderr output) to zip...
2011 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002012 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002013 MYLOGE("Failed to add dumpstate log to .zip file\n");
2014 return false;
2015 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002016 // TODO: Should truncate the existing file.
2017 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002018 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2019 return false;
2020 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002021 fprintf(stderr, "\n");
2022
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002023 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002024 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002025 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002026 return false;
2027 }
2028
Felipe Leme1d486fe2016-10-14 18:06:47 -07002029 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2030 ds.zip_file.reset(nullptr);
2031
Felipe Lemee9d2c542016-11-15 11:48:26 -08002032 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002033 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002034
Felipe Leme1e9edc62015-12-21 16:02:13 -08002035 return true;
2036}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002037
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07002038static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07002039 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
2040 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07002041 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002042 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002043 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002044 }
2045
2046 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002047 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002048
2049 std::vector<uint8_t> buffer(65536);
2050 while (1) {
2051 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
2052 if (bytes_read == 0) {
2053 break;
2054 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002055 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002056 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002057 }
2058
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002059 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002060 }
2061
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002062 uint8_t hash[SHA256_DIGEST_LENGTH];
2063 SHA256_Final(hash, &ctx);
2064
2065 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
2066 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00002067 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002068 }
2069 hash_buffer[sizeof(hash_buffer) - 1] = 0;
2070 return std::string(hash_buffer);
2071}
2072
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002073static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2074 // clang-format off
2075 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2076 "--receiver-foreground", "--receiver-include-background", "-a", action};
2077 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002078
2079 am.insert(am.end(), args.begin(), args.end());
2080
Felipe Leme8d2410e2017-02-08 09:46:08 -08002081 RunCommand("", am,
2082 CommandOptions::WithTimeout(20)
2083 .Log("Sending broadcast: '%s'\n")
2084 .Always()
2085 .DropRoot()
2086 .RedirectStderr()
2087 .Build());
2088}
2089
Felipe Leme35b8cf12017-02-10 15:47:29 -08002090static void Vibrate(int duration_ms) {
2091 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002092 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002093 CommandOptions::WithTimeout(10)
2094 .Log("Vibrate: '%s'\n")
2095 .Always()
2096 .Build());
2097 // clang-format on
2098}
2099
Nandana Dutt979388e2018-11-30 16:48:55 +00002100static void MaybeResolveSymlink(std::string* path) {
2101 std::string resolved_path;
2102 if (android::base::Readlink(*path, &resolved_path)) {
2103 *path = resolved_path;
2104 }
2105}
2106
Nandana Dutt4be45d12018-09-26 15:04:23 +01002107/*
2108 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2109 * if we are writing zip files and adds the version file.
2110 */
2111static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002112 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2113
Nandana Dutt4be45d12018-09-26 15:04:23 +01002114 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2115 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002116 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002117 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002118 char date[80];
2119 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2120 ds.name_ = date;
2121 } else {
2122 ds.name_ = "undated";
2123 }
2124
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002125 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002126 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002127 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002128 ds.base_name_ += "-wifi";
2129 }
2130
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002131 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002132 ds.screenshot_path_ = ds.GetPath(".png");
2133 }
2134 ds.tmp_path_ = ds.GetPath(".tmp");
2135 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2136
Nandana Dutt54dbd672019-01-11 12:58:05 +00002137 std::string destination = ds.options_->bugreport_fd.get() != -1
2138 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002139 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002140 MYLOGD(
2141 "Bugreport dir: %s\n"
2142 "Base name: %s\n"
2143 "Suffix: %s\n"
2144 "Log path: %s\n"
2145 "Temporary path: %s\n"
2146 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002147 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2148 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002149
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002150 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002151 ds.path_ = ds.GetPath(".zip");
2152 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2153 create_parent_dirs(ds.path_.c_str());
2154 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2155 if (ds.zip_file == nullptr) {
2156 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2157 } else {
2158 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2159 }
2160 ds.AddTextZipEntry("version.txt", ds.version_);
2161 }
2162}
2163
2164/*
2165 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
2166 * printing zipped file status, etc.
2167 */
2168static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002169 /* check if user changed the suffix using system properties */
2170 std::string name =
2171 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
2172 bool change_suffix = false;
2173 if (!name.empty()) {
2174 /* must whitelist which characters are allowed, otherwise it could cross directories */
2175 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
2176 if (std::regex_match(name.c_str(), valid_regex)) {
2177 change_suffix = true;
2178 } else {
2179 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
2180 }
2181 }
2182 if (change_suffix) {
2183 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
2184 ds.name_ = name;
2185 if (!ds.screenshot_path_.empty()) {
2186 std::string new_screenshot_path = ds.GetPath(".png");
2187 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
2188 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
2189 new_screenshot_path.c_str(), strerror(errno));
2190 } else {
2191 ds.screenshot_path_ = new_screenshot_path;
2192 }
2193 }
2194 }
2195
2196 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002197 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002198 if (!ds.FinishZipFile()) {
2199 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2200 do_text_file = true;
2201 } else {
2202 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002203 // If the user has changed the suffix, we need to change the zip file name.
2204 std::string new_path = ds.GetPath(".zip");
2205 if (ds.path_ != new_path) {
2206 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2207 if (rename(ds.path_.c_str(), new_path.c_str())) {
2208 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2209 strerror(errno));
2210 } else {
2211 ds.path_ = new_path;
2212 }
2213 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002214 }
2215 }
2216 if (do_text_file) {
2217 ds.path_ = ds.GetPath(".txt");
2218 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2219 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2220 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2221 ds.path_.clear();
2222 }
2223 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002224 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002225 if (do_text_file) {
2226 dprintf(ds.control_socket_fd_,
2227 "FAIL:could not create zip file, check %s "
2228 "for more details\n",
2229 ds.log_path_.c_str());
2230 } else {
2231 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2232 }
2233 }
2234}
2235
2236/* Broadcasts that we are done with the bugreport */
2237static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002238 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002239 if (!ds.path_.empty()) {
2240 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002241 // clang-format off
2242
2243 std::vector<std::string> am_args = {
2244 "--receiver-permission", "android.permission.DUMP",
2245 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2246 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2247 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002248 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002249 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2250 };
2251 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002252 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002253 am_args.push_back("--es");
2254 am_args.push_back("android.intent.extra.SCREENSHOT");
2255 am_args.push_back(ds.screenshot_path_);
2256 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002257 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002258 am_args.push_back("--es");
2259 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002260 am_args.push_back(ds.options_->notification_title);
2261 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002262 am_args.push_back("--es");
2263 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002264 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002265 }
2266 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002267 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002268 am_args.push_back("--es");
2269 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002270 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002271 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2272 } else {
2273 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2274 }
2275 } else {
2276 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2277 }
2278}
2279
Nandana Dutt58d72e22018-11-16 10:30:48 +00002280static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2281 switch (mode) {
2282 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2283 return "BUGREPORT_FULL";
2284 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2285 return "BUGREPORT_INTERACTIVE";
2286 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2287 return "BUGREPORT_REMOTE";
2288 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2289 return "BUGREPORT_WEAR";
2290 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2291 return "BUGREPORT_TELEPHONY";
2292 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2293 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002294 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2295 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002296 }
2297}
2298
2299static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002300 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002301 switch (mode) {
2302 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2303 options->do_broadcast = true;
2304 options->do_fb = true;
2305 break;
2306 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002307 // Currently, the dumpstate binder is only used by Shell to update progress.
2308 options->do_start_service = true;
2309 options->do_progress_updates = true;
2310 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002311 options->do_broadcast = true;
2312 break;
2313 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002314 options->do_vibrate = false;
2315 options->is_remote_mode = true;
2316 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002317 options->do_broadcast = true;
2318 break;
2319 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002320 options->do_start_service = true;
2321 options->do_progress_updates = true;
2322 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002323 options->do_fb = true;
2324 options->do_broadcast = true;
2325 break;
2326 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002327 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002328 options->do_progress_updates = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002329 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002330 options->do_broadcast = true;
2331 break;
2332 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002333 options->wifi_only = true;
2334 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002335 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002336 options->do_broadcast = true;
2337 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002338 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2339 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002340 }
2341}
2342
2343static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002344 // If the system property is not set, it's assumed to be a default bugreport.
2345 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002346
2347 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2348 if (!extra_options.empty()) {
2349 // Framework uses a system property to override some command-line args.
2350 // Currently, it contains the type of the requested bugreport.
2351 if (extra_options == "bugreportplus") {
2352 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002353 } else if (extra_options == "bugreportfull") {
2354 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002355 } else if (extra_options == "bugreportremote") {
2356 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2357 } else if (extra_options == "bugreportwear") {
2358 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2359 } else if (extra_options == "bugreporttelephony") {
2360 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2361 } else if (extra_options == "bugreportwifi") {
2362 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002363 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002364 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002365 }
2366 // Reset the property
2367 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2368 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002369 return mode;
2370}
2371
2372// TODO: Move away from system properties when we have options passed via binder calls.
2373/* Sets runtime options from the system properties and then clears those properties. */
2374static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2375 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2376 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002377
2378 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2379 if (!options->notification_title.empty()) {
2380 // Reset the property
2381 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2382
Nandana Duttdd8cca32018-11-14 10:10:29 +00002383 options->notification_description =
2384 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002385 if (!options->notification_description.empty()) {
2386 // Reset the property
2387 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2388 }
2389 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2390 options->notification_description.c_str());
2391 }
2392}
2393
Nandana Dutt58d72e22018-11-16 10:30:48 +00002394static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2395 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2396 MYLOGI("do_add_date: %d\n", options.do_add_date);
2397 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2398 MYLOGI("use_socket: %d\n", options.use_socket);
2399 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2400 MYLOGI("do_fb: %d\n", options.do_fb);
2401 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2402 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2403 MYLOGI("show_header_only: %d\n", options.show_header_only);
2404 MYLOGI("do_start_service: %d\n", options.do_start_service);
2405 MYLOGI("telephony_only: %d\n", options.telephony_only);
2406 MYLOGI("wifi_only: %d\n", options.wifi_only);
2407 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002408 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002409 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2410 MYLOGI("args: %s\n", options.args.c_str());
2411 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2412 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2413}
2414
Nandana Dutt54dbd672019-01-11 12:58:05 +00002415void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2416 const android::base::unique_fd& bugreport_fd_in,
2417 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002418 // In the new API world, date is always added; output is always a zip file.
2419 // TODO(111441001): remove these options once they are obsolete.
2420 do_add_date = true;
2421 do_zip_file = true;
2422
Nandana Dutt54dbd672019-01-11 12:58:05 +00002423 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2424 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2425 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002426
2427 extra_options = ModeToString(bugreport_mode);
2428 SetOptionsFromMode(bugreport_mode, this);
2429}
2430
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002431Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2432 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002433 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002434 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002435 switch (c) {
2436 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002437 case 'd': do_add_date = true; break;
2438 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002439 // o=use_outfile not supported anymore.
2440 // TODO(b/111441001): Remove when all callers have migrated.
2441 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002442 case 's': use_socket = true; break;
2443 case 'S': use_control_socket = true; break;
2444 case 'v': show_header_only = true; break;
2445 case 'q': do_vibrate = false; break;
2446 case 'p': do_fb = true; break;
2447 case 'P': do_progress_updates = true; break;
2448 case 'R': is_remote_mode = true; break;
2449 case 'B': do_broadcast = true; break;
2450 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002451 case 'w':
2452 // This was already processed
2453 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002454 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002455 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002456 break;
2457 default:
2458 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002459 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002460 break;
2461 // clang-format on
2462 }
2463 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002464
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002465 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002466 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002467 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002468 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002469 }
2470 }
2471
2472 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2473 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002474
2475 SetOptionsFromProperties(this);
2476 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002477}
2478
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002479bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002480 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002481 return false;
2482 }
2483
Nandana Dutt9a76d202019-01-21 15:56:48 +00002484 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002485 return false;
2486 }
2487
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002488 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002489 return false;
2490 }
2491
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002492 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002493 return false;
2494 }
2495
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002496 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002497 return false;
2498 }
2499 return true;
2500}
2501
Nandana Dutt197661d2018-11-16 16:40:21 +00002502void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2503 options_ = std::move(options);
2504}
2505
Nandana Duttd2f5f082019-01-18 17:13:52 +00002506Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2507 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002508 if (listener_ != nullptr) {
2509 switch (status) {
2510 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002511 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002512 break;
2513 case Dumpstate::RunStatus::HELP:
2514 break;
2515 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002516 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002517 break;
2518 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002519 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2520 break;
2521 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2522 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2523 break;
2524 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2525 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002526 break;
2527 }
2528 }
2529 return status;
2530}
2531
Nandana Dutt979388e2018-11-30 16:48:55 +00002532/*
2533 * Dumps relevant information to a bugreport based on the given options.
2534 *
2535 * The bugreport can be dumped to a file or streamed to a socket.
2536 *
2537 * How dumping to file works:
2538 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2539 * stderr is redirected a log file.
2540 *
2541 * The temporary bugreport is then populated via printfs, dumping contents of files and
2542 * output of commands to stdout.
2543 *
2544 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2545 * text file.
2546 *
2547 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2548 * gets added to the archive.
2549 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002550 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2551 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002552 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002553Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2554 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002555 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002556 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002557 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002558 return RunStatus::INVALID_INPUT;
2559 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002560 /* set as high priority, and protect from OOM killer */
2561 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002562
Felipe Lemed071c682016-10-20 16:48:00 -07002563 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002564 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002565 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002566 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002567 } else {
2568 /* fallback to kernels <= 2.6.35 */
2569 oom_adj = fopen("/proc/self/oom_adj", "we");
2570 if (oom_adj) {
2571 fputs("-17", oom_adj);
2572 fclose(oom_adj);
2573 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002574 }
2575
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002576 if (version_ == VERSION_DEFAULT) {
2577 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002578 }
2579
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002580 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002581 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002582 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002583 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002584 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002585 }
2586
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002587 if (options_->show_header_only) {
2588 PrintHeader();
2589 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002590 }
2591
Nandana Duttd2f5f082019-01-18 17:13:52 +00002592 if (options_->bugreport_fd.get() != -1) {
2593 // If the output needs to be copied over to the caller's fd, get user consent.
2594 android::String16 package(calling_package.c_str());
2595 CheckUserConsent(calling_uid, package);
2596 }
2597
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002598 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002599 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002600
2601 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002602 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002603 is_redirecting
2604 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2605 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002606 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002607
Felipe Lemed071c682016-10-20 16:48:00 -07002608 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002609 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002610 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002611 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2612
2613 MYLOGI("begin\n");
2614
Sahana Raof35ed432019-07-12 10:47:52 +01002615 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2616 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2617 } else {
2618 // Wake lock will be released automatically on process death
2619 MYLOGD("Wake lock acquired.\n");
2620 }
2621
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002622 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002623
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002624 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002625 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002626 MYLOGI("Starting 'dumpstate' service\n");
2627 android::status_t ret;
2628 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2629 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2630 }
2631 }
2632
Felipe Lemef0292972016-11-22 13:57:05 -08002633 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002634 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2635 }
2636
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002637 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2638 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002639
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002640 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002641
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002642 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002643
Christopher Ferrised9354f2014-10-01 17:35:01 -07002644 // If we are going to use a socket, do it as early as possible
2645 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002646 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002647 if (!redirect_to_socket(stdout, "dumpstate")) {
2648 return ERROR;
2649 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002650 }
2651
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002652 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002653 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002654 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002655 if (control_socket_fd_ == -1) {
2656 return ERROR;
2657 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002658 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002659 }
2660
Felipe Leme71bbfc52015-11-23 14:14:51 -08002661 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002662 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002663
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002664 if (options_->do_progress_updates) {
2665 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002666 // clang-format off
2667 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002668 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002669 "--es", "android.intent.extra.NAME", name_,
2670 "--ei", "android.intent.extra.ID", std::to_string(id_),
2671 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2672 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002673 };
2674 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002675 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002676 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002677 if (options_->use_control_socket) {
2678 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002679 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002680 }
2681 }
2682
Nick Kralevichf3599b32016-01-25 15:05:16 -08002683 /* read /proc/cmdline before dropping root */
2684 FILE *cmdline = fopen("/proc/cmdline", "re");
2685 if (cmdline) {
2686 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2687 fclose(cmdline);
2688 }
2689
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002690 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002691 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002692 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002693
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002694 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002695 MYLOGI("taking early screenshot\n");
2696 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002697 }
2698
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002699 if (options_->do_zip_file && zip_file != nullptr) {
2700 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2701 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002702 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002703 }
2704 }
2705
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002706 int dup_stdout_fd;
2707 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002708 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002709 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002710 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002711 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2712 return ERROR;
2713 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002714 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2715 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2716 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002717 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002718
2719 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2720 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002721 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002722 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002723 /* TODO: rather than generating a text file now and zipping it later,
2724 it would be more efficient to redirect stdout to the zip entry
2725 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002726 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2727 return ERROR;
2728 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002729 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002730 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002731 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002732 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002733 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002734
2735 // Don't buffer stdout
2736 setvbuf(stdout, nullptr, _IONBF, 0);
2737
Felipe Leme608385d2016-02-01 10:35:38 -08002738 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2739 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002740 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002741 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002742
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002743 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002744 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002745 DumpstateBoard();
2746 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002747 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002748 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002749 // Dump state for the default case. This also drops root.
Nandana Dutt5c390032019-03-12 10:52:56 +00002750 RunStatus s = DumpstateDefault();
2751 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002752 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002753 HandleUserConsentDenied();
2754 }
2755 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002756 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002757 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002758
Felipe Leme55b42a62015-11-10 17:39:08 -08002759 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002760 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002761 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002762 }
2763
Nandana Duttd2f5f082019-01-18 17:13:52 +00002764 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002765 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002766 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002767 }
2768
Nandana Duttd2f5f082019-01-18 17:13:52 +00002769 // Share the final file with the caller if the user has consented.
2770 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2771 if (options_->bugreport_fd.get() != -1) {
2772 status = CopyBugreportIfUserConsented();
2773 if (status != Dumpstate::RunStatus::OK &&
2774 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2775 // Do an early return if there were errors. We make an exception for consent
2776 // timing out because it's possible the user got distracted. In this case the
2777 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002778 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002779 return status;
2780 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002781 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002782 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2783 options_->screenshot_fd.get());
2784 if (copy_succeeded) {
2785 android::os::UnlinkAndLogOnError(screenshot_path_);
2786 }
2787 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002788 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2789 MYLOGI(
2790 "Did not receive user consent yet."
2791 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002792 const String16 incidentcompanion("incidentcompanion");
2793 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2794 if (ics != nullptr) {
2795 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2796 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2797 consent_callback_.get());
2798 } else {
2799 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2800 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002801 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002802 }
2803
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002804 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002805 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002806 for (int i = 0; i < 3; i++) {
2807 Vibrate(75);
2808 usleep((75 + 50) * 1000);
2809 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002810 }
2811
Jeff Brown1dc94e32014-09-11 14:15:27 -07002812 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002813 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002814 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002815 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002816 }
2817
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002818 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2819 progress_->GetInitialMax());
2820 progress_->Save();
2821 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002822
Felipe Leme107a05f2016-03-08 15:11:15 -08002823 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002824 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002825 }
2826
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002827 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002828 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002829 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002830 }
2831
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002832 tombstone_data_.clear();
2833 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002834
Nandana Duttd2f5f082019-01-18 17:13:52 +00002835 return (consent_callback_ != nullptr &&
2836 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2837 ? USER_CONSENT_TIMED_OUT
2838 : RunStatus::OK;
2839}
2840
2841void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2842 consent_callback_ = new ConsentCallback();
2843 const String16 incidentcompanion("incidentcompanion");
2844 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2845 if (ics != nullptr) {
2846 MYLOGD("Checking user consent via incidentcompanion service\n");
2847 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Joe Onorato1c36d752019-03-17 18:26:43 -07002848 calling_uid, calling_package, String16(), String16(),
2849 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002850 } else {
2851 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2852 }
2853}
2854
Nandana Dutt5c390032019-03-12 10:52:56 +00002855bool Dumpstate::IsUserConsentDenied() const {
2856 return ds.consent_callback_ != nullptr &&
2857 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2858}
2859
Nandana Duttd2f5f082019-01-18 17:13:52 +00002860void Dumpstate::CleanupFiles() {
2861 android::os::UnlinkAndLogOnError(tmp_path_);
2862 android::os::UnlinkAndLogOnError(screenshot_path_);
2863 android::os::UnlinkAndLogOnError(path_);
2864}
2865
2866Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2867 MYLOGD("User denied consent; deleting files and returning\n");
2868 CleanupFiles();
2869 return USER_CONSENT_DENIED;
2870}
2871
2872Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2873 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2874 // user consent.
2875 UserConsentResult consent_result = consent_callback_->getResult();
2876 if (consent_result == UserConsentResult::UNAVAILABLE) {
2877 // User has not responded yet.
2878 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2879 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2880 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2881 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2882 sleep(delay_seconds);
2883 }
2884 consent_result = consent_callback_->getResult();
2885 }
2886 if (consent_result == UserConsentResult::DENIED) {
2887 // User has explicitly denied sharing with the app. To be safe delete the
2888 // internal bugreport & tmp files.
2889 return HandleUserConsentDenied();
2890 }
2891 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002892 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2893 if (copy_succeeded) {
2894 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002895 }
2896 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2897 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2898 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2899 // Since we do not have user consent to share the bugreport it does not get
2900 // copied over to the calling app but remains in the internal directory from
2901 // where the user can manually pull it.
2902 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2903 }
2904 // Unknown result; must be a programming error.
2905 MYLOGE("Unknown user consent result:%d\n", consent_result);
2906 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002907}
2908
Nandana Duttf02564e2019-02-15 15:24:24 +00002909Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002910 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2911 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2912 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002913 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002914 // When directly running dumpstate binary, the output is not expected to be written
2915 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002916 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002917
2918 // calling_uid and calling_package are for user consent to share the bugreport with
2919 // an app; they are irrelvant here because bugreport is only written to a local
2920 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002921 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002922 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002923 return status;
2924}
2925
2926/* Main entry point for dumpstate binary. */
2927int run_main(int argc, char* argv[]) {
2928 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002929
2930 switch (status) {
2931 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002932 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002933 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002934 ShowUsage();
2935 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002936 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002937 fprintf(stderr, "Invalid combination of args\n");
2938 ShowUsage();
2939 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002940 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002941 FALLTHROUGH_INTENDED;
2942 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2943 FALLTHROUGH_INTENDED;
2944 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002945 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002946 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002947}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002948
2949// TODO(111441001): Default DumpOptions to sensible values.
2950Dumpstate::Dumpstate(const std::string& version)
2951 : pid_(getpid()),
2952 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01002953 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002954 version_(version),
2955 now_(time(nullptr)) {
2956}
2957
2958Dumpstate& Dumpstate::GetInstance() {
2959 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2960 return singleton_;
2961}
2962
Nandana Dutt8d945c02019-08-14 13:30:07 +01002963DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2964 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002965 if (!title_.empty()) {
2966 started_ = Nanotime();
2967 }
2968}
2969
2970DurationReporter::~DurationReporter() {
2971 if (!title_.empty()) {
2972 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002973 if (elapsed >= .5f || verbose_) {
2974 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002975 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002976 if (!logcat_only_) {
2977 // Use "Yoda grammar" to make it easier to grep|sort sections.
2978 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002979 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002980 }
2981}
2982
2983const int32_t Progress::kDefaultMax = 5000;
2984
2985Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2986}
2987
2988Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2989 : Progress(initial_max, growth_factor, "") {
2990 progress_ = progress;
2991}
2992
2993Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2994 : initial_max_(initial_max),
2995 progress_(0),
2996 max_(initial_max),
2997 growth_factor_(growth_factor),
2998 n_runs_(0),
2999 average_max_(0),
3000 path_(path) {
3001 if (!path_.empty()) {
3002 Load();
3003 }
3004}
3005
3006void Progress::Load() {
3007 MYLOGD("Loading stats from %s\n", path_.c_str());
3008 std::string content;
3009 if (!android::base::ReadFileToString(path_, &content)) {
3010 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3011 return;
3012 }
3013 if (content.empty()) {
3014 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3015 return;
3016 }
3017 std::vector<std::string> lines = android::base::Split(content, "\n");
3018
3019 if (lines.size() < 1) {
3020 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3021 (int)lines.size(), max_);
3022 return;
3023 }
3024 char* ptr;
3025 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3026 average_max_ = strtol(ptr, nullptr, 10);
3027 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3028 average_max_ > STATS_MAX_AVERAGE) {
3029 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3030 initial_max_ = Progress::kDefaultMax;
3031 } else {
3032 initial_max_ = average_max_;
3033 }
3034 max_ = initial_max_;
3035
3036 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3037}
3038
3039void Progress::Save() {
3040 int32_t total = n_runs_ * average_max_ + progress_;
3041 int32_t runs = n_runs_ + 1;
3042 int32_t average = floor(((float)total) / runs);
3043 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3044 path_.c_str());
3045 if (path_.empty()) {
3046 return;
3047 }
3048
3049 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3050 if (!android::base::WriteStringToFile(content, path_)) {
3051 MYLOGE("Could not save stats on %s\n", path_.c_str());
3052 }
3053}
3054
3055int32_t Progress::Get() const {
3056 return progress_;
3057}
3058
3059bool Progress::Inc(int32_t delta_sec) {
3060 bool changed = false;
3061 if (delta_sec >= 0) {
3062 progress_ += delta_sec;
3063 if (progress_ > max_) {
3064 int32_t old_max = max_;
3065 max_ = floor((float)progress_ * growth_factor_);
3066 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3067 changed = true;
3068 }
3069 }
3070 return changed;
3071}
3072
3073int32_t Progress::GetMax() const {
3074 return max_;
3075}
3076
3077int32_t Progress::GetInitialMax() const {
3078 return initial_max_;
3079}
3080
3081void Progress::Dump(int fd, const std::string& prefix) const {
3082 const char* pr = prefix.c_str();
3083 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3084 dprintf(fd, "%smax: %d\n", pr, max_);
3085 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3086 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3087 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3088 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3089 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3090}
3091
3092bool Dumpstate::IsZipping() const {
3093 return zip_writer_ != nullptr;
3094}
3095
3096std::string Dumpstate::GetPath(const std::string& suffix) const {
3097 return GetPath(bugreport_internal_dir_, suffix);
3098}
3099
3100std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3101 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3102 name_.c_str(), suffix.c_str());
3103}
3104
3105void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3106 progress_ = std::move(progress);
3107}
3108
3109void for_each_userid(void (*func)(int), const char *header) {
3110 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3111 "for_each_userid(%s)", header);
3112 DurationReporter duration_reporter(title);
3113 if (PropertiesHelper::IsDryRun()) return;
3114
3115 DIR *d;
3116 struct dirent *de;
3117
3118 if (header) printf("\n------ %s ------\n", header);
3119 func(0);
3120
3121 if (!(d = opendir("/data/system/users"))) {
3122 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3123 return;
3124 }
3125
3126 while ((de = readdir(d))) {
3127 int userid;
3128 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3129 continue;
3130 }
3131 func(userid);
3132 }
3133
3134 closedir(d);
3135}
3136
3137static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3138 DIR *d;
3139 struct dirent *de;
3140
3141 if (!(d = opendir("/proc"))) {
3142 printf("Failed to open /proc (%s)\n", strerror(errno));
3143 return;
3144 }
3145
3146 if (header) printf("\n------ %s ------\n", header);
3147 while ((de = readdir(d))) {
3148 if (ds.IsUserConsentDenied()) {
3149 MYLOGE(
3150 "Returning early because user denied consent to share bugreport with calling app.");
3151 closedir(d);
3152 return;
3153 }
3154 int pid;
3155 int fd;
3156 char cmdpath[255];
3157 char cmdline[255];
3158
3159 if (!(pid = atoi(de->d_name))) {
3160 continue;
3161 }
3162
3163 memset(cmdline, 0, sizeof(cmdline));
3164
3165 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3166 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3167 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3168 close(fd);
3169 if (cmdline[0]) {
3170 helper(pid, cmdline, arg);
3171 continue;
3172 }
3173 }
3174
3175 // if no cmdline, a kernel thread has comm
3176 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3177 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3178 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3179 close(fd);
3180 if (cmdline[1]) {
3181 cmdline[0] = '[';
3182 size_t len = strcspn(cmdline, "\f\b\r\n");
3183 cmdline[len] = ']';
3184 cmdline[len+1] = '\0';
3185 }
3186 }
3187 if (!cmdline[0]) {
3188 strcpy(cmdline, "N/A");
3189 }
3190 helper(pid, cmdline, arg);
3191 }
3192
3193 closedir(d);
3194}
3195
3196static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3197 for_each_pid_func *func = (for_each_pid_func*) arg;
3198 func(pid, cmdline);
3199}
3200
3201void for_each_pid(for_each_pid_func func, const char *header) {
3202 std::string title = header == nullptr ? "for_each_pid"
3203 : android::base::StringPrintf("for_each_pid(%s)", header);
3204 DurationReporter duration_reporter(title);
3205 if (PropertiesHelper::IsDryRun()) return;
3206
3207 __for_each_pid(for_each_pid_helper, header, (void *) func);
3208}
3209
3210static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3211 DIR *d;
3212 struct dirent *de;
3213 char taskpath[255];
3214 for_each_tid_func *func = (for_each_tid_func *) arg;
3215
3216 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3217
3218 if (!(d = opendir(taskpath))) {
3219 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3220 return;
3221 }
3222
3223 func(pid, pid, cmdline);
3224
3225 while ((de = readdir(d))) {
3226 if (ds.IsUserConsentDenied()) {
3227 MYLOGE(
3228 "Returning early because user denied consent to share bugreport with calling app.");
3229 closedir(d);
3230 return;
3231 }
3232 int tid;
3233 int fd;
3234 char commpath[255];
3235 char comm[255];
3236
3237 if (!(tid = atoi(de->d_name))) {
3238 continue;
3239 }
3240
3241 if (tid == pid)
3242 continue;
3243
3244 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3245 memset(comm, 0, sizeof(comm));
3246 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3247 strcpy(comm, "N/A");
3248 } else {
3249 char *c;
3250 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3251 close(fd);
3252
3253 c = strrchr(comm, '\n');
3254 if (c) {
3255 *c = '\0';
3256 }
3257 }
3258 func(pid, tid, comm);
3259 }
3260
3261 closedir(d);
3262}
3263
3264void for_each_tid(for_each_tid_func func, const char *header) {
3265 std::string title = header == nullptr ? "for_each_tid"
3266 : android::base::StringPrintf("for_each_tid(%s)", header);
3267 DurationReporter duration_reporter(title);
3268
3269 if (PropertiesHelper::IsDryRun()) return;
3270
3271 __for_each_pid(for_each_tid_helper, header, (void *) func);
3272}
3273
3274void show_wchan(int pid, int tid, const char *name) {
3275 if (PropertiesHelper::IsDryRun()) return;
3276
3277 char path[255];
3278 char buffer[255];
3279 int fd, ret, save_errno;
3280 char name_buffer[255];
3281
3282 memset(buffer, 0, sizeof(buffer));
3283
3284 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3285 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3286 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3287 return;
3288 }
3289
3290 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3291 save_errno = errno;
3292 close(fd);
3293
3294 if (ret < 0) {
3295 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3296 return;
3297 }
3298
3299 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3300 pid == tid ? 0 : 3, "", name);
3301
3302 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3303
3304 return;
3305}
3306
3307// print time in centiseconds
3308static void snprcent(char *buffer, size_t len, size_t spc,
3309 unsigned long long time) {
3310 static long hz; // cache discovered hz
3311
3312 if (hz <= 0) {
3313 hz = sysconf(_SC_CLK_TCK);
3314 if (hz <= 0) {
3315 hz = 1000;
3316 }
3317 }
3318
3319 // convert to centiseconds
3320 time = (time * 100 + (hz / 2)) / hz;
3321
3322 char str[16];
3323
3324 snprintf(str, sizeof(str), " %llu.%02u",
3325 time / 100, (unsigned)(time % 100));
3326 size_t offset = strlen(buffer);
3327 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3328 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3329}
3330
3331// print permille as a percent
3332static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3333 char str[16];
3334
3335 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3336 size_t offset = strlen(buffer);
3337 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3338 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3339}
3340
3341void show_showtime(int pid, const char *name) {
3342 if (PropertiesHelper::IsDryRun()) return;
3343
3344 char path[255];
3345 char buffer[1023];
3346 int fd, ret, save_errno;
3347
3348 memset(buffer, 0, sizeof(buffer));
3349
3350 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3351 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3352 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3353 return;
3354 }
3355
3356 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3357 save_errno = errno;
3358 close(fd);
3359
3360 if (ret < 0) {
3361 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3362 return;
3363 }
3364
3365 // field 14 is utime
3366 // field 15 is stime
3367 // field 42 is iotime
3368 unsigned long long utime = 0, stime = 0, iotime = 0;
3369 if (sscanf(buffer,
3370 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3371 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3372 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3373 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3374 &utime, &stime, &iotime) != 3) {
3375 return;
3376 }
3377
3378 unsigned long long total = utime + stime;
3379 if (!total) {
3380 return;
3381 }
3382
3383 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3384 if (permille > 1000) {
3385 permille = 1000;
3386 }
3387
3388 // try to beautify and stabilize columns at <80 characters
3389 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3390 if ((name[0] != '[') || utime) {
3391 snprcent(buffer, sizeof(buffer), 57, utime);
3392 }
3393 snprcent(buffer, sizeof(buffer), 65, stime);
3394 if ((name[0] != '[') || iotime) {
3395 snprcent(buffer, sizeof(buffer), 73, iotime);
3396 }
3397 if (iotime) {
3398 snprdec(buffer, sizeof(buffer), 79, permille);
3399 }
3400 puts(buffer); // adds a trailing newline
3401
3402 return;
3403}
3404
3405void do_dmesg() {
3406 const char *title = "KERNEL LOG (dmesg)";
3407 DurationReporter duration_reporter(title);
3408 printf("------ %s ------\n", title);
3409
3410 if (PropertiesHelper::IsDryRun()) return;
3411
3412 /* Get size of kernel buffer */
3413 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3414 if (size <= 0) {
3415 printf("Unexpected klogctl return value: %d\n\n", size);
3416 return;
3417 }
3418 char *buf = (char *) malloc(size + 1);
3419 if (buf == nullptr) {
3420 printf("memory allocation failed\n\n");
3421 return;
3422 }
3423 int retval = klogctl(KLOG_READ_ALL, buf, size);
3424 if (retval < 0) {
3425 printf("klogctl failure\n\n");
3426 free(buf);
3427 return;
3428 }
3429 buf[retval] = '\0';
3430 printf("%s\n\n", buf);
3431 free(buf);
3432 return;
3433}
3434
3435void do_showmap(int pid, const char *name) {
3436 char title[255];
3437 char arg[255];
3438
3439 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3440 snprintf(arg, sizeof(arg), "%d", pid);
3441 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3442}
3443
3444int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3445 DurationReporter duration_reporter(title);
3446
3447 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3448
3449 UpdateProgress(WEIGHT_FILE);
3450
3451 return status;
3452}
3453
3454int read_file_as_long(const char *path, long int *output) {
3455 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3456 if (fd < 0) {
3457 int err = errno;
3458 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3459 return -1;
3460 }
3461 char buffer[50];
3462 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3463 if (bytes_read == -1) {
3464 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3465 return -2;
3466 }
3467 if (bytes_read == 0) {
3468 MYLOGE("File %s is empty\n", path);
3469 return -3;
3470 }
3471 *output = atoi(buffer);
3472 return 0;
3473}
3474
3475/* calls skip to gate calling dump_from_fd recursively
3476 * in the specified directory. dump_from_fd defaults to
3477 * dump_file_from_fd above when set to NULL. skip defaults
3478 * to false when set to NULL. dump_from_fd will always be
3479 * called with title NULL.
3480 */
3481int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3482 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3483 DurationReporter duration_reporter(title);
3484 DIR *dirp;
3485 struct dirent *d;
3486 char *newpath = nullptr;
3487 const char *slash = "/";
3488 int retval = 0;
3489
3490 if (!title.empty()) {
3491 printf("------ %s (%s) ------\n", title.c_str(), dir);
3492 }
3493 if (PropertiesHelper::IsDryRun()) return 0;
3494
3495 if (dir[strlen(dir) - 1] == '/') {
3496 ++slash;
3497 }
3498 dirp = opendir(dir);
3499 if (dirp == nullptr) {
3500 retval = -errno;
3501 MYLOGE("%s: %s\n", dir, strerror(errno));
3502 return retval;
3503 }
3504
3505 if (!dump_from_fd) {
3506 dump_from_fd = dump_file_from_fd;
3507 }
3508 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3509 if ((d->d_name[0] == '.')
3510 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3511 || (d->d_name[1] == '\0'))) {
3512 continue;
3513 }
3514 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3515 (d->d_type == DT_DIR) ? "/" : "");
3516 if (!newpath) {
3517 retval = -errno;
3518 continue;
3519 }
3520 if (skip && (*skip)(newpath)) {
3521 continue;
3522 }
3523 if (d->d_type == DT_DIR) {
3524 int ret = dump_files("", newpath, skip, dump_from_fd);
3525 if (ret < 0) {
3526 retval = ret;
3527 }
3528 continue;
3529 }
3530 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3531 if (fd.get() < 0) {
3532 retval = -1;
3533 printf("*** %s: %s\n", newpath, strerror(errno));
3534 continue;
3535 }
3536 (*dump_from_fd)(nullptr, newpath, fd.get());
3537 }
3538 closedir(dirp);
3539 if (!title.empty()) {
3540 printf("\n");
3541 }
3542 return retval;
3543}
3544
3545/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3546 * it's possible to avoid issues where opening the file itself can get
3547 * stuck.
3548 */
3549int dump_file_from_fd(const char *title, const char *path, int fd) {
3550 if (PropertiesHelper::IsDryRun()) return 0;
3551
3552 int flags = fcntl(fd, F_GETFL);
3553 if (flags == -1) {
3554 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3555 return -1;
3556 } else if (!(flags & O_NONBLOCK)) {
3557 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3558 return -1;
3559 }
3560 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3561}
3562
3563int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003564 const CommandOptions& options, bool verbose_duration) {
3565 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003566
3567 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3568
3569 /* TODO: for now we're simplifying the progress calculation by using the
3570 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3571 * where its weight should be much higher proportionally to its timeout.
3572 * Ideally, it should use a options.EstimatedDuration() instead...*/
3573 UpdateProgress(options.Timeout());
3574
3575 return status;
3576}
3577
3578void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3579 const CommandOptions& options, long dumpsysTimeoutMs) {
3580 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3581 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3582 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3583 RunCommand(title, dumpsys, options);
3584}
3585
3586int open_socket(const char *service) {
3587 int s = android_get_control_socket(service);
3588 if (s < 0) {
3589 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3590 return -1;
3591 }
3592 fcntl(s, F_SETFD, FD_CLOEXEC);
3593
3594 // Set backlog to 0 to make sure that queue size will be minimum.
3595 // In Linux, because the minimum queue will be 1, connect() will be blocked
3596 // if the other clients already called connect() and the connection request was not accepted.
3597 if (listen(s, 0) < 0) {
3598 MYLOGE("listen(control socket): %s\n", strerror(errno));
3599 return -1;
3600 }
3601
3602 struct sockaddr addr;
3603 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003604 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003605
3606 // Close socket just after accept(), to make sure that connect() by client will get error
3607 // when the socket is used by the other services.
3608 // There is still a race condition possibility between accept and close, but there is no way
3609 // to close-on-accept atomically.
3610 // See detail; b/123306389#comment25
3611 close(s);
3612
3613 if (fd < 0) {
3614 MYLOGE("accept(control socket): %s\n", strerror(errno));
3615 return -1;
3616 }
3617
3618 return fd;
3619}
3620
3621/* redirect output to a service control socket */
3622bool redirect_to_socket(FILE* redirect, const char* service) {
3623 int fd = open_socket(service);
3624 if (fd == -1) {
3625 return false;
3626 }
3627 fflush(redirect);
3628 // TODO: handle dup2 failure
3629 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3630 close(fd);
3631 return true;
3632}
3633
3634// TODO: should call is_valid_output_file and/or be merged into it.
3635void create_parent_dirs(const char *path) {
3636 char *chp = const_cast<char *> (path);
3637
3638 /* skip initial slash */
3639 if (chp[0] == '/')
3640 chp++;
3641
3642 /* create leading directories, if necessary */
3643 struct stat dir_stat;
3644 while (chp && chp[0]) {
3645 chp = strchr(chp, '/');
3646 if (chp) {
3647 *chp = 0;
3648 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3649 MYLOGI("Creating directory %s\n", path);
3650 if (mkdir(path, 0770)) { /* drwxrwx--- */
3651 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3652 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3653 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3654 }
3655 }
3656 *chp++ = '/';
3657 }
3658 }
3659}
3660
3661bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3662 create_parent_dirs(path);
3663
3664 int fd = TEMP_FAILURE_RETRY(open(path,
3665 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3666 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3667 if (fd < 0) {
3668 MYLOGE("%s: %s\n", path, strerror(errno));
3669 return false;
3670 }
3671
3672 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3673 close(fd);
3674 return true;
3675}
3676
3677bool redirect_to_file(FILE* redirect, char* path) {
3678 return _redirect_to_file(redirect, path, O_TRUNC);
3679}
3680
3681bool redirect_to_existing_file(FILE* redirect, char* path) {
3682 return _redirect_to_file(redirect, path, O_APPEND);
3683}
3684
3685void dump_route_tables() {
3686 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3687 if (PropertiesHelper::IsDryRun()) return;
3688 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3689 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3690 FILE* fp = fopen(RT_TABLES_PATH, "re");
3691 if (!fp) {
3692 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3693 return;
3694 }
3695 char table[16];
3696 // Each line has an integer (the table number), a space, and a string (the table name). We only
3697 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3698 // Add a fixed max limit so this doesn't go awry.
3699 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3700 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3701 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3702 }
3703 fclose(fp);
3704}
3705
3706// TODO: make this function thread safe if sections are generated in parallel.
3707void Dumpstate::UpdateProgress(int32_t delta_sec) {
3708 if (progress_ == nullptr) {
3709 MYLOGE("UpdateProgress: progress_ not set\n");
3710 return;
3711 }
3712
3713 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003714 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003715
3716 // ...but only notifiy listeners when necessary.
3717 if (!options_->do_progress_updates) return;
3718
3719 int progress = progress_->Get();
3720 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003721 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003722
Nandana Duttf02cd782019-06-14 14:25:13 +01003723 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003724 return;
3725 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003726 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003727
3728 if (control_socket_fd_ >= 0) {
3729 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3730 fsync(control_socket_fd_);
3731 }
3732
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003733 if (listener_ != nullptr) {
3734 if (percent % 5 == 0) {
3735 // We don't want to spam logcat, so only log multiples of 5.
3736 MYLOGD("Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(), progress, max,
3737 percent);
3738 } else {
3739 // stderr is ignored on normal invocations, but useful when calling
3740 // /system/bin/dumpstate directly for debuggging.
3741 fprintf(stderr, "Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(),
3742 progress, max, percent);
3743 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003744
3745 listener_->onProgress(percent);
3746 }
3747}
3748
3749void Dumpstate::TakeScreenshot(const std::string& path) {
3750 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3751 int status =
3752 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3753 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3754 if (status == 0) {
3755 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3756 } else {
3757 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3758 }
3759}
3760
3761bool is_dir(const char* pathname) {
3762 struct stat info;
3763 if (stat(pathname, &info) == -1) {
3764 return false;
3765 }
3766 return S_ISDIR(info.st_mode);
3767}
3768
3769time_t get_mtime(int fd, time_t default_mtime) {
3770 struct stat info;
3771 if (fstat(fd, &info) == -1) {
3772 return default_mtime;
3773 }
3774 return info.st_mtime;
3775}