blob: 312db67e4f2ad11d8cf7c5d2e1f6ca36d65ce534 [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 +0000237
Nikita Ioffea325a572019-05-16 19:49:47 +0100238int64_t GetModuleMetadataVersion() {
239 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
240 if (binder == nullptr) {
241 MYLOGE("Failed to retrieve package_native service");
242 return 0L;
243 }
244 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
245 std::string package_name;
246 auto status = package_service->getModuleMetadataPackageName(&package_name);
247 if (!status.isOk()) {
248 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
249 return 0L;
250 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100251 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100252 int64_t version_code;
253 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
254 &version_code);
255 if (!status.isOk()) {
256 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
257 return 0L;
258 }
259 return version_code;
260}
261
Nandana Dutt979388e2018-11-30 16:48:55 +0000262} // namespace
263} // namespace os
264} // namespace android
265
Felipe Leme678727a2016-09-21 17:22:11 -0700266static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800267 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800268 long dumpsysTimeoutMs = 0) {
269 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700270}
271static int DumpFile(const std::string& title, const std::string& path) {
272 return ds.DumpFile(title, path);
273}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800274
Felipe Lemee844a9d2016-09-21 15:01:39 -0700275// Relative directory (inside the zip) for all files copied as-is into the bugreport.
276static const std::string ZIP_ROOT_DIR = "FS";
277
Vishnu Naire97d6122018-01-18 13:58:56 -0800278static const std::string kProtoPath = "proto/";
279static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700280static const std::string kDumpstateBoardFiles[] = {
281 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700282 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700283};
284static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
285
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700286static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700287static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700288
Felipe Lemef0292972016-11-22 13:57:05 -0800289static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
290
Narayan Kamath8f788292017-05-25 13:20:39 +0100291/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100292 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
293 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
294 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100295 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700296static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
297 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700298 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100299 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
300
Narayan Kamathbd863722017-06-01 18:50:12 +0100301 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100302
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700303 if (dump_dir == nullptr) {
304 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700305 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700306 }
307
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700308 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100309 struct dirent* entry = nullptr;
310 while ((entry = readdir(dump_dir.get()))) {
311 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100312 continue;
313 }
314
Narayan Kamathbd863722017-06-01 18:50:12 +0100315 const std::string base_name(entry->d_name);
316 if (base_name.find(file_prefix) != 0) {
317 continue;
318 }
319
320 const std::string abs_path = dir_path + base_name;
321 android::base::unique_fd fd(
322 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
323 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700324 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100325 break;
326 }
327
328 struct stat st = {};
329 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700330 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100331 continue;
332 }
333
Narayan Kamath3f31b632018-02-22 19:42:36 +0000334 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100335 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100336 continue;
337 }
338
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700339 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700340 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100341
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700342 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100343}
344
Narayan Kamathbd863722017-06-01 18:50:12 +0100345static bool AddDumps(const std::vector<DumpData>::const_iterator start,
346 const std::vector<DumpData>::const_iterator end,
347 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100348 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100349 for (auto it = start; it != end; ++it) {
350 const std::string& name = it->name;
351 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100352 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100353
354 // Seek to the beginning of the file before dumping any data. A given
355 // DumpData entry might be dumped multiple times in the report.
356 //
357 // For example, the most recent ANR entry is dumped to the body of the
358 // main entry and it also shows up as a separate entry in the bugreport
359 // ZIP file.
360 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
361 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
362 strerror(errno));
363 }
364
Narayan Kamath8f788292017-05-25 13:20:39 +0100365 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800366 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100367 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100368 }
369 } else {
370 dump_file_from_fd(type_name, name.c_str(), fd);
371 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100372 }
373
374 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700375}
376
Felipe Leme635ca312016-01-05 14:23:02 -0800377// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700378void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800379 char path[PATH_MAX];
380
381 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
382 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700383 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800384 char linkname[PATH_MAX];
385 ssize_t r = readlink(path, linkname, PATH_MAX);
386 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800387 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800388 return;
389 }
390 linkname[r] = '\0';
391
392 if (mount_points.find(linkname) == mount_points.end()) {
393 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700394 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700395 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800396 mount_points.insert(linkname);
397 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800398 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800399 }
400 }
401}
402
403void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700404 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700405 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800406 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800407 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700408 for_each_pid(do_mountinfo, nullptr);
409 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800410}
411
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700412static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
413{
414 DIR *d;
415 struct dirent *de;
416 char path[PATH_MAX];
417
418 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700419 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700420 return;
421 }
422
423 while ((de = readdir(d))) {
424 if (de->d_type != DT_LNK) {
425 continue;
426 }
427 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700428 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700429 }
430
431 closedir(d);
432}
433
Mark Salyzyn326842f2015-04-30 09:49:41 -0700434static bool skip_not_stat(const char *path) {
435 static const char stat[] = "/stat";
436 size_t len = strlen(path);
437 if (path[len - 1] == '/') { /* Directory? */
438 return false;
439 }
440 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
441}
442
Felipe Leme4c2d6632016-09-28 14:32:00 -0700443static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800444 return false;
445}
446
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700447unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700448
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800449//
450// stat offsets
451// Name units description
452// ---- ----- -----------
453// read I/Os requests number of read I/Os processed
454#define __STAT_READ_IOS 0
455// read merges requests number of read I/Os merged with in-queue I/O
456#define __STAT_READ_MERGES 1
457// read sectors sectors number of sectors read
458#define __STAT_READ_SECTORS 2
459// read ticks milliseconds total wait time for read requests
460#define __STAT_READ_TICKS 3
461// write I/Os requests number of write I/Os processed
462#define __STAT_WRITE_IOS 4
463// write merges requests number of write I/Os merged with in-queue I/O
464#define __STAT_WRITE_MERGES 5
465// write sectors sectors number of sectors written
466#define __STAT_WRITE_SECTORS 6
467// write ticks milliseconds total wait time for write requests
468#define __STAT_WRITE_TICKS 7
469// in_flight requests number of I/Os currently in flight
470#define __STAT_IN_FLIGHT 8
471// io_ticks milliseconds total time this block device has been active
472#define __STAT_IO_TICKS 9
473// time_in_queue milliseconds total wait time for all requests
474#define __STAT_IN_QUEUE 10
475#define __STAT_NUMBER_FIELD 11
476//
477// read I/Os, write I/Os
478// =====================
479//
480// These values increment when an I/O request completes.
481//
482// read merges, write merges
483// =========================
484//
485// These values increment when an I/O request is merged with an
486// already-queued I/O request.
487//
488// read sectors, write sectors
489// ===========================
490//
491// These values count the number of sectors read from or written to this
492// block device. The "sectors" in question are the standard UNIX 512-byte
493// sectors, not any device- or filesystem-specific block size. The
494// counters are incremented when the I/O completes.
495#define SECTOR_SIZE 512
496//
497// read ticks, write ticks
498// =======================
499//
500// These values count the number of milliseconds that I/O requests have
501// waited on this block device. If there are multiple I/O requests waiting,
502// these values will increase at a rate greater than 1000/second; for
503// example, if 60 read requests wait for an average of 30 ms, the read_ticks
504// field will increase by 60*30 = 1800.
505//
506// in_flight
507// =========
508//
509// This value counts the number of I/O requests that have been issued to
510// the device driver but have not yet completed. It does not include I/O
511// requests that are in the queue but not yet issued to the device driver.
512//
513// io_ticks
514// ========
515//
516// This value counts the number of milliseconds during which the device has
517// had I/O requests queued.
518//
519// time_in_queue
520// =============
521//
522// This value counts the number of milliseconds that I/O requests have waited
523// on this block device. If there are multiple I/O requests waiting, this
524// value will increase as the product of the number of milliseconds times the
525// number of requests waiting (see "read ticks" above for an example).
526#define S_TO_MS 1000
527//
528
Mark Salyzyn326842f2015-04-30 09:49:41 -0700529static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800530 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700531 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700532 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700533 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700534 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700535 getline(&buffer, &i, fp);
536 fclose(fp);
537 if (!buffer) {
538 return -errno;
539 }
540 i = strlen(buffer);
541 while ((i > 0) && (buffer[i - 1] == '\n')) {
542 buffer[--i] = '\0';
543 }
544 if (!*buffer) {
545 free(buffer);
546 return 0;
547 }
548 z = true;
549 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800550 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700551 if (fields[i] != 0) {
552 z = false;
553 }
554 }
555 if (z) { /* never accessed */
556 free(buffer);
557 return 0;
558 }
559
Wei Wang509bb5d2017-06-09 14:42:12 -0700560 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
561 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700562 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700563
564 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
565 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
566 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700567 free(buffer);
568
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800569 if (fields[__STAT_IO_TICKS]) {
570 unsigned long read_perf = 0;
571 unsigned long read_ios = 0;
572 if (fields[__STAT_READ_TICKS]) {
573 unsigned long long divisor = fields[__STAT_READ_TICKS]
574 * fields[__STAT_IO_TICKS];
575 read_perf = ((unsigned long long)SECTOR_SIZE
576 * fields[__STAT_READ_SECTORS]
577 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
578 / divisor;
579 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
580 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
581 / divisor;
582 }
583
584 unsigned long write_perf = 0;
585 unsigned long write_ios = 0;
586 if (fields[__STAT_WRITE_TICKS]) {
587 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
588 * fields[__STAT_IO_TICKS];
589 write_perf = ((unsigned long long)SECTOR_SIZE
590 * fields[__STAT_WRITE_SECTORS]
591 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
592 / divisor;
593 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
594 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
595 / divisor;
596 }
597
598 unsigned queue = (fields[__STAT_IN_QUEUE]
599 + (fields[__STAT_IO_TICKS] >> 1))
600 / fields[__STAT_IO_TICKS];
601
602 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700603 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 -0800604 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700605 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 -0800606 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800607 }
608
609 /* bugreport timeout factor adjustment */
610 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
611 worst_write_perf = write_perf;
612 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700613 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700614 return 0;
615}
616
Yao Chenbe3bbc12018-01-17 16:31:10 -0800617static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
618
619/* timeout in ms to read a list of buffers */
620static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
621 unsigned long timeout_ms = 0;
622 for (const auto& buffer : buffers) {
623 log_id_t id = android_name_to_log_id(buffer.c_str());
624 unsigned long property_size = __android_logger_get_buffer_size(id);
625 /* Engineering margin is ten-fold our guess */
626 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
627 }
628 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700629}
630
Nandana Duttd2f5f082019-01-18 17:13:52 +0000631Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
632}
633
634android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
635 std::lock_guard<std::mutex> lock(lock_);
636 result_ = APPROVED;
637 MYLOGD("User approved consent to share bugreport\n");
638 return android::binder::Status::ok();
639}
640
641android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
642 std::lock_guard<std::mutex> lock(lock_);
643 result_ = DENIED;
644 MYLOGW("User denied consent to share bugreport\n");
645 return android::binder::Status::ok();
646}
647
648UserConsentResult Dumpstate::ConsentCallback::getResult() {
649 std::lock_guard<std::mutex> lock(lock_);
650 return result_;
651}
652
653uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800654 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000655}
656
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700657void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700658 std::string build, fingerprint, radio, bootloader, network;
659 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700660
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700661 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
662 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700663 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
664 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
665 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700666 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700667
Felipe Lemed8b94e52016-12-08 10:21:44 -0800668 printf("========================================================\n");
669 printf("== dumpstate: %s\n", date);
670 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700671
Felipe Lemed8b94e52016-12-08 10:21:44 -0800672 printf("\n");
673 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700674 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800675 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
676 printf("Bootloader: %s\n", bootloader.c_str());
677 printf("Radio: %s\n", radio.c_str());
678 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100679 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
680 if (module_metadata_version != 0) {
681 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
682 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700683
Felipe Lemed8b94e52016-12-08 10:21:44 -0800684 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800685 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800686 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800687 printf("Uptime: ");
688 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
689 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800690 printf("Bugreport format version: %s\n", version_.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +0100691 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s bugreport_mode=%s\n", id_, pid_,
692 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800693 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800694}
695
Felipe Leme24b66ee2016-06-16 10:55:26 -0700696// List of file extensions that can cause a zip file attachment to be rejected by some email
697// service providers.
698static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
699 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
700 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
701 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
702};
703
Vishnu Naire97d6122018-01-18 13:58:56 -0800704status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
705 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700706 if (!IsZipping()) {
707 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
708 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800709 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800710 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700711 std::string valid_name = entry_name;
712
713 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700714 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700715 if (idx != std::string::npos) {
716 std::string extension = entry_name.substr(idx);
717 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
718 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
719 valid_name = entry_name + ".renamed";
720 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
721 }
722 }
723
Felipe Leme6fe9db62016-02-12 09:04:16 -0800724 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
725 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700726 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
727 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700728 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700729 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700730 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800731 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800732 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000733 bool finished_entry = false;
734 auto finish_entry = [this, &finished_entry] {
735 if (!finished_entry) {
736 // This should only be called when we're going to return an earlier error,
737 // which would've been logged. This may imply the file is already corrupt
738 // and any further logging from FinishEntry is more likely to mislead than
739 // not.
740 this->zip_writer_->FinishEntry();
741 }
742 };
743 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800744 auto start = std::chrono::steady_clock::now();
745 auto end = start + timeout;
746 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800747
Felipe Leme770410d2016-01-26 17:07:14 -0800748 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800749 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800750 if (timeout.count() > 0) {
751 // lambda to recalculate the timeout.
752 auto time_left_ms = [end]() {
753 auto now = std::chrono::steady_clock::now();
754 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
755 return std::max(diff.count(), 0LL);
756 };
757
758 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
759 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000760 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
761 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800762 return -errno;
763 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000764 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800765 entry_name.c_str(), strerror(errno), timeout.count());
766 return TIMED_OUT;
767 }
768 }
769
Zach Riggle22200402016-08-18 01:01:24 -0400770 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800771 if (bytes_read == 0) {
772 break;
773 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800774 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800775 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800776 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700777 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800778 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700779 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800780 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800781 }
782 }
783
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700784 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000785 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700786 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700787 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800788 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800789 }
790
Vishnu Naire97d6122018-01-18 13:58:56 -0800791 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800792}
793
Felipe Leme1d486fe2016-10-14 18:06:47 -0700794bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
795 android::base::unique_fd fd(
796 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700797 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800798 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800799 return false;
800 }
801
Vishnu Naire97d6122018-01-18 13:58:56 -0800802 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800803}
804
805/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700806static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800807 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800808}
809
Felipe Leme1d486fe2016-10-14 18:06:47 -0700810void Dumpstate::AddDir(const std::string& dir, bool recursive) {
811 if (!IsZipping()) {
812 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800813 return;
814 }
Felipe Leme678727a2016-09-21 17:22:11 -0700815 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800816 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700817 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800818}
819
Felipe Leme1d486fe2016-10-14 18:06:47 -0700820bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
821 if (!IsZipping()) {
822 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
823 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800824 return false;
825 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800826 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700827 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700828 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700829 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700830 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800831 return false;
832 }
833
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700834 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700835 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700836 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700837 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800838 return false;
839 }
840
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700841 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700842 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700843 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800844 return false;
845 }
846
847 return true;
848}
849
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800850static void DoKmsg() {
851 struct stat st;
852 if (!stat(PSTORE_LAST_KMSG, &st)) {
853 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
854 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
855 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
856 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
857 } else {
858 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
859 DumpFile("LAST KMSG", "/proc/last_kmsg");
860 }
861}
862
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800863static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800864 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800865 RunCommand(
866 "KERNEL LOG",
867 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
868 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
869}
870
Nandana Duttdb379fa2019-10-09 16:54:41 +0100871static void DoSystemLogcat(time_t since) {
872 char since_str[80];
873 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
874
875 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
876 RunCommand("SYSTEM LOG",
877 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
878 since_str},
879 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
880}
881
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800882static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800883 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800884 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
885 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800886 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100887 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800888 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
889 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800890 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800891 RunCommand(
892 "EVENT LOG",
893 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100894 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800895 timeout_ms = logcat_timeout({"stats"});
896 RunCommand(
897 "STATS LOG",
898 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100899 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800900 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800901 RunCommand(
902 "RADIO LOG",
903 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100904 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800905
906 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
907
908 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800909 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
910 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800911}
912
Mike Ma5c267872019-08-21 11:31:34 -0700913static void DumpIncidentReport() {
914 if (!ds.IsZipping()) {
915 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
916 return;
917 }
918 DurationReporter duration_reporter("INCIDENT REPORT");
919 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
920 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
921 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
922 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
923 if (fd < 0) {
924 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
925 return;
926 }
927 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
928 bool empty = 0 == lseek(fd, 0, SEEK_END);
929 if (!empty) {
930 // Use a different name from "incident.proto"
931 // /proto/incident.proto is reserved for incident service dump
932 // i.e. metadata for debugging.
933 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
934 }
935 unlink(path.c_str());
936}
937
Sunny Goyal35949782019-11-19 15:54:36 -0800938static void DumpVisibleWindowViews() {
939 if (!ds.IsZipping()) {
940 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
941 return;
942 }
943 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
944 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
945 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
946 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
947 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
948 if (fd < 0) {
949 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
950 return;
951 }
952 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
953 CommandOptions::WithTimeout(120).Build());
954 bool empty = 0 == lseek(fd, 0, SEEK_END);
955 if (!empty) {
956 ds.AddZipEntry("visible_windows.zip", path);
957 } else {
958 MYLOGW("Failed to dump visible windows\n");
959 }
960 unlink(path.c_str());
961}
962
Jayachandran Ca94c7172017-06-10 15:08:12 -0700963static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700964 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
965 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900966 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700967 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900968 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
969 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
970 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
971 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700972}
973
David Andersond9ba4752018-12-11 18:26:59 -0800974static void DumpDynamicPartitionInfo() {
975 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
976 return;
977 }
978
979 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -0700980 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -0800981}
982
Narayan Kamath8f788292017-05-25 13:20:39 +0100983static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
984 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
985 anr_traces_dir.c_str());
986
987 // If we're here, dump_traces_path will always be a temporary file
988 // (created with mkostemp or similar) that contains dumps taken earlier
989 // on in the process.
990 if (dump_traces_path != nullptr) {
991 if (add_to_zip) {
992 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
993 } else {
994 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
995 dump_traces_path);
996 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
997 }
998
999 const int ret = unlink(dump_traces_path);
1000 if (ret == -1) {
1001 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1002 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001003 }
1004 }
1005
Narayan Kamathbd863722017-06-01 18:50:12 +01001006 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001007 if (ds.anr_data_.size() > 0) {
1008 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001009 "VM TRACES AT LAST ANR", add_to_zip);
1010
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001011 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1012 // it will be present in the body of the main entry if |add_to_zip| == false.
1013 //
1014 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001015 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001016 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001017 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001018 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1019 }
1020}
1021
1022static void AddAnrTraceFiles() {
1023 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1024
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001025 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001026
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001027 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001028
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001029 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1030
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001031 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001032 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001033 int i = 0;
1034 while (true) {
1035 const std::string slow_trace_path =
1036 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1037 if (stat(slow_trace_path.c_str(), &st)) {
1038 // No traces file at this index, done with the files.
1039 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001040 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001041 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1042 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001043 }
1044}
1045
Wei Wang509bb5d2017-06-09 14:42:12 -07001046static void DumpBlockStatFiles() {
1047 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001048
Wei Wang1dc1ef52017-06-12 11:28:37 -07001049 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1050
1051 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001052 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1053 return;
1054 }
1055
1056 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001057 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001058 if ((d->d_name[0] == '.')
1059 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1060 || (d->d_name[1] == '\0'))) {
1061 continue;
1062 }
1063 const std::string new_path =
1064 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1065 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1066 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1067 printf("\n");
1068 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001069 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001070}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001071
1072static void DumpPacketStats() {
1073 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1074 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1075 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1076 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1077 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1078}
1079
1080static void DumpIpAddrAndRules() {
1081 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1082 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1083 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1084 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1085 RunCommand("IP RULES", {"ip", "rule", "show"});
1086 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1087}
1088
Nandana Dutt5c390032019-03-12 10:52:56 +00001089static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1090 std::chrono::milliseconds timeout,
1091 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001092 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001093 sp<android::IServiceManager> sm = defaultServiceManager();
1094 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001095 Vector<String16> args;
1096 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001097 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1098 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001099 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001100 std::string path(title);
1101 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001102 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001103 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001104 if (status == OK) {
1105 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1106 std::chrono::duration<double> elapsed_seconds;
1107 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1108 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001109 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1110 bool dump_complete = (status == OK);
1111 dumpsys.stopDumpThread(dump_complete);
1112 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001113
1114 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1115 std::chrono::steady_clock::now() - start);
1116 if (elapsed_duration > timeout) {
1117 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1118 elapsed_duration.count());
1119 break;
1120 }
1121 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001122 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001123}
1124
Vishnu Nair64afc022018-02-01 15:29:34 -08001125static void RunDumpsysText(const std::string& title, int priority,
1126 std::chrono::milliseconds timeout,
1127 std::chrono::milliseconds service_timeout) {
1128 DurationReporter duration_reporter(title);
1129 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1130 fsync(STDOUT_FILENO);
1131 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1132}
1133
1134/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001135static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1136 std::chrono::milliseconds timeout,
1137 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001138 DurationReporter duration_reporter(title);
1139 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1140 fsync(STDOUT_FILENO);
1141 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1142 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001143
1144 RETURN_IF_USER_DENIED_CONSENT();
1145
1146 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1147 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001148}
1149
Nandana Dutt5c390032019-03-12 10:52:56 +00001150static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1151 std::chrono::milliseconds timeout,
1152 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001153 if (!ds.IsZipping()) {
1154 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001155 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001156 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001157 sp<android::IServiceManager> sm = defaultServiceManager();
1158 Dumpsys dumpsys(sm.get());
1159 Vector<String16> args;
1160 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1161 DurationReporter duration_reporter(title);
1162
1163 auto start = std::chrono::steady_clock::now();
1164 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1165 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001166 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001167 std::string path(kProtoPath);
1168 path.append(String8(service).c_str());
1169 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1170 path.append("_CRITICAL");
1171 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1172 path.append("_HIGH");
1173 }
1174 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001175 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001176 if (status == OK) {
1177 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1178 bool dumpTerminated = (status == OK);
1179 dumpsys.stopDumpThread(dumpTerminated);
1180 }
1181 ZipWriter::FileEntry file_entry;
1182 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001183
1184 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1185 std::chrono::steady_clock::now() - start);
1186 if (elapsed_duration > timeout) {
1187 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1188 elapsed_duration.count());
1189 break;
1190 }
1191 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001192 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001193}
1194
Nandana Dutta7db6342018-11-21 14:53:34 +00001195// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001196static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001197 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1198 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001199
1200 RETURN_IF_USER_DENIED_CONSENT();
1201
1202 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1203 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001204}
1205
1206// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001207static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001208 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1209 // high priority. Reduce timeout once they are able to dump in a shorter time or
1210 // moved to a parallel task.
1211 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1212 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001213
1214 RETURN_IF_USER_DENIED_CONSENT();
1215
1216 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1217 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001218}
1219
1220// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001221static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001222 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001223
1224 RETURN_IF_USER_DENIED_CONSENT();
1225
1226 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1227 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001228}
1229
Steven Moreland44cd9482018-01-04 16:24:13 -08001230static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001231 if (!ds.IsZipping()) {
1232 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1233 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1234 return;
1235 }
1236 DurationReporter duration_reporter("DUMP HALS");
1237 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001238 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001239
Steven Moreland44cd9482018-01-04 16:24:13 -08001240 using android::hidl::manager::V1_0::IServiceManager;
1241 using android::hardware::defaultServiceManager;
1242
1243 sp<IServiceManager> sm = defaultServiceManager();
1244 if (sm == nullptr) {
1245 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1246 return;
1247 }
1248
1249 auto ret = sm->list([&](const auto& interfaces) {
1250 for (const std::string& interface : interfaces) {
1251 std::string cleanName = interface;
1252 std::replace_if(cleanName.begin(),
1253 cleanName.end(),
1254 [](char c) {
1255 return !isalnum(c) &&
1256 std::string("@-_:.").find(c) == std::string::npos;
1257 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001258 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001259
1260 {
1261 auto fd = android::base::unique_fd(
1262 TEMP_FAILURE_RETRY(open(path.c_str(),
1263 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1264 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1265 if (fd < 0) {
1266 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1267 continue;
1268 }
1269 RunCommandToFd(fd,
1270 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001271 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001272 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1273
1274 bool empty = 0 == lseek(fd, 0, SEEK_END);
1275 if (!empty) {
1276 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1277 }
1278 }
1279
1280 unlink(path.c_str());
1281 }
1282 });
1283
1284 if (!ret.isOk()) {
1285 MYLOGE("Could not list hals from hwservicemanager.\n");
1286 }
1287}
1288
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001289static void DumpExternalFragmentationInfo() {
1290 struct stat st;
1291 if (stat("/proc/buddyinfo", &st) != 0) {
1292 MYLOGE("Unable to dump external fragmentation info\n");
1293 return;
1294 }
1295
1296 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1297 std::ifstream ifs("/proc/buddyinfo");
1298 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1299 for (std::string line; std::getline(ifs, line);) {
1300 std::smatch match_results;
1301 if (std::regex_match(line, match_results, unusable_index_regex)) {
1302 std::stringstream free_pages(std::string{match_results[3]});
1303 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1304 std::istream_iterator<int>());
1305
1306 int total_free_pages = 0;
1307 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1308 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1309 }
1310
1311 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1312 match_results[2].str().c_str());
1313
1314 int usable_free_pages = total_free_pages;
1315 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1316 auto unusable_index = (total_free_pages - usable_free_pages) /
1317 static_cast<double>(total_free_pages);
1318 printf(" %5.3f", unusable_index);
1319 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1320 }
1321
1322 printf("\n");
1323 }
1324 }
1325 printf("\n");
1326}
1327
Nandana Dutt5c390032019-03-12 10:52:56 +00001328// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1329// via the consent they are shown. Ignores other errors that occur while running various
1330// commands. The consent checking is currently done around long running tasks, which happen to
1331// be distributed fairly evenly throughout the function.
1332static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001333 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001334
Nandana Dutt5c390032019-03-12 10:52:56 +00001335 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1336 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1337 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001338 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001339 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001340 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001341 DumpFile("MEMORY INFO", "/proc/meminfo");
1342 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001343 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001344
1345 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1346
Sunny Goyal35949782019-11-19 15:54:36 -08001347 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1348
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001349 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1350 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1351 DumpFile("SLAB INFO", "/proc/slabinfo");
1352 DumpFile("ZONEINFO", "/proc/zoneinfo");
1353 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1354 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001355 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001356
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001357 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1358 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001359
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001360 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001361 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001362
1363 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1364 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001365
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001366 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001367
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001368 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001369 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001370 struct stat s;
1371 if (stat("/proc/modules", &s) != 0) {
1372 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1373 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001374 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001375 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001376
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001377 if (__android_logger_property_get_bool(
1378 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1379 DoKernelLogcat();
1380 } else {
1381 do_dmesg();
1382 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001383
Felipe Lemef0292972016-11-22 13:57:05 -08001384 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001385
1386 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1387
Jeff Brown1dc94e32014-09-11 14:15:27 -07001388 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001389 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001390
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001391 /* Dump Bluetooth HCI logs */
1392 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001393
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001394 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001395 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001396 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001397 }
1398
Felipe Lemee184f662016-10-27 10:04:47 -07001399 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001400
Narayan Kamath8f788292017-05-25 13:20:39 +01001401 // NOTE: tombstones are always added as separate entries in the zip archive
1402 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001403 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001404 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001405 if (!tombstones_dumped) {
1406 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001407 }
1408
Jayachandran Ca94c7172017-06-10 15:08:12 -07001409 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001410
Chenbo Feng276a3b62018-08-07 11:44:49 -07001411 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1412
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001413 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001414
Jayachandran Ca94c7172017-06-10 15:08:12 -07001415 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001416
1417 dump_route_tables();
1418
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001419 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1420 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1421 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001422
Nandana Dutt5c390032019-03-12 10:52:56 +00001423 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001424
Elliott Hughes23ccc622017-02-28 10:14:22 -08001425 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001426
Jin Qianf334d662017-10-10 14:41:37 -07001427 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001428
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001429 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001430
Colin Crossf45fa6b2012-03-26 12:38:26 -07001431 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001432 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1433 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1434 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1435 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1436 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001437
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001438 /* Add window and surface trace files. */
1439 if (!PropertiesHelper::IsUserBuild()) {
1440 ds.AddDir(WMTRACE_DATA_DIR, false);
1441 }
1442
Nandana Dutt5c390032019-03-12 10:52:56 +00001443 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001444
Steven Moreland7440ddb2016-12-15 16:13:39 -08001445 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001446 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1447 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001448 // su does not exist on user builds, so try running without it.
1449 // This way any implementations of vril-dump that do not require
1450 // root can run on user builds.
1451 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001452 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001453 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001454 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001455 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001456 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001457 }
1458
Felipe Lemed8b94e52016-12-08 10:21:44 -08001459 printf("========================================================\n");
1460 printf("== Android Framework Services\n");
1461 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001462
Nandana Dutt5c390032019-03-12 10:52:56 +00001463 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001464
Felipe Lemed8b94e52016-12-08 10:21:44 -08001465 printf("========================================================\n");
1466 printf("== Checkins\n");
1467 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001468
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001469 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001470
1471 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1472
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001473 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1474 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1475 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1476 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001477
Felipe Lemed8b94e52016-12-08 10:21:44 -08001478 printf("========================================================\n");
1479 printf("== Running Application Activities\n");
1480 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001481
Makoto Onuki60780982018-04-16 15:34:00 -07001482 // The following dumpsys internally collects output from running apps, so it can take a long
1483 // time. So let's extend the timeout.
1484
1485 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1486
1487 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001488
Felipe Lemed8b94e52016-12-08 10:21:44 -08001489 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001490 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001491 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001492
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001493 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001494 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001495
Felipe Lemed8b94e52016-12-08 10:21:44 -08001496 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001497 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001498 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001499
Makoto Onuki60780982018-04-16 15:34:00 -07001500 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1501 DUMPSYS_COMPONENTS_OPTIONS);
1502
1503 printf("========================================================\n");
1504 printf("== Running Application Providers (platform)\n");
1505 printf("========================================================\n");
1506
1507 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1508 DUMPSYS_COMPONENTS_OPTIONS);
1509
1510 printf("========================================================\n");
1511 printf("== Running Application Providers (non-platform)\n");
1512 printf("========================================================\n");
1513
1514 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1515 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001516
Adrian Roos8b397ab2017-04-04 16:35:44 -07001517 printf("========================================================\n");
1518 printf("== Dropbox crashes\n");
1519 printf("========================================================\n");
1520
1521 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1522 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1523
Felipe Lemed8b94e52016-12-08 10:21:44 -08001524 printf("========================================================\n");
1525 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1526 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1527 printf("========================================================\n");
1528 printf("== dumpstate: done (id %d)\n", ds.id_);
1529 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001530
1531 printf("========================================================\n");
1532 printf("== Obtaining statsd metadata\n");
1533 printf("========================================================\n");
1534 // This differs from the usual dumpsys stats, which is the stats report data.
1535 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001536
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001537 // Add linker configuration directory
1538 ds.AddDir(LINKERCONFIG_DIR, true);
1539
Mike Ma5c267872019-08-21 11:31:34 -07001540 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1541
Nandana Dutt5c390032019-03-12 10:52:56 +00001542 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001543}
1544
Nandana Dutt5c390032019-03-12 10:52:56 +00001545/*
1546 * Dumps state for the default case; drops root after it's no longer necessary.
1547 *
1548 * Returns RunStatus::OK if everything went fine.
1549 * Returns RunStatus::ERROR if there was an error.
1550 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1551 * with the caller.
1552 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001553Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001554 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1555 // buffer.
1556 DoLogcat();
1557 // Capture timestamp after first logcat to use in next logcat
1558 time_t logcat_ts = time(nullptr);
1559
Nandana Dutt4be45d12018-09-26 15:04:23 +01001560 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001561 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001562
1563 /* Run some operations that require root. */
1564 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1565 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1566
1567 ds.AddDir(RECOVERY_DIR, true);
1568 ds.AddDir(RECOVERY_DATA_DIR, true);
1569 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1570 ds.AddDir(LOGPERSIST_DATA_DIR, false);
Yifan Hong0efa7972020-02-03 16:45:02 -08001571 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001572 if (!PropertiesHelper::IsUserBuild()) {
1573 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1574 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1575 }
1576 add_mountinfo();
1577 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001578 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001579 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001580
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001581 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001582 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1583
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001584 // Dump IPsec stats. No keys are exposed here.
1585 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1586
Nandana Dutt4be45d12018-09-26 15:04:23 +01001587 // Run ss as root so we can see socket marks.
1588 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1589
1590 // Run iotop as root to show top 100 IO threads
1591 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1592
Erick Reyese68df822019-02-11 14:46:36 -08001593 // Gather shared memory buffer info if the product implements it
1594 struct stat st;
1595 if (!stat("/product/bin/dmabuf_dump", &st)) {
1596 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1597 }
1598
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001599 DumpFile("PSI cpu", "/proc/pressure/cpu");
1600 DumpFile("PSI memory", "/proc/pressure/memory");
1601 DumpFile("PSI io", "/proc/pressure/io");
1602
Nandana Dutt4be45d12018-09-26 15:04:23 +01001603 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001604 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001605 }
1606
Nandana Dutt5c390032019-03-12 10:52:56 +00001607 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001608 Dumpstate::RunStatus status = dumpstate();
1609 // Capture logcat since the last time we did it.
1610 DoSystemLogcat(logcat_ts);
1611 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001612}
1613
mukesh agrawal253dad42018-01-23 21:59:59 -08001614// This method collects common dumpsys for telephony and wifi
1615static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001616 DumpIpTablesAsRoot();
1617
Jayachandran Cb4389d92019-07-08 09:46:05 -07001618 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1619
Jayachandran Ca94c7172017-06-10 15:08:12 -07001620 if (!DropRootUser()) {
1621 return;
1622 }
1623
1624 do_dmesg();
1625 DoLogcat();
1626 DumpPacketStats();
1627 DoKmsg();
1628 DumpIpAddrAndRules();
1629 dump_route_tables();
Jayachandran Cb4389d92019-07-08 09:46:05 -07001630 DumpHals();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001631
1632 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1633 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001634}
1635
1636// This method collects dumpsys for telephony debugging only
1637static void DumpstateTelephonyOnly() {
1638 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001639
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001640 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001641
1642 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001643
1644 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1645
1646 printf("========================================================\n");
1647 printf("== Android Framework Services\n");
1648 printf("========================================================\n");
1649
Vishnu Nair652cc802017-11-30 15:18:30 -08001650 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1651 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001652 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1653 SEC_TO_MSEC(10));
1654 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001655 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1656 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001657 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1658 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001659 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1660 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001661
1662 printf("========================================================\n");
1663 printf("== Running Application Services\n");
1664 printf("========================================================\n");
1665
1666 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1667
1668 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001669 printf("== Running Application Services (non-platform)\n");
1670 printf("========================================================\n");
1671
1672 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1673 DUMPSYS_COMPONENTS_OPTIONS);
1674
1675 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001676 printf("== Checkins\n");
1677 printf("========================================================\n");
1678
1679 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1680
1681 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001682 printf("== dumpstate: done (id %d)\n", ds.id_);
1683 printf("========================================================\n");
1684}
1685
mukesh agrawal253dad42018-01-23 21:59:59 -08001686// This method collects dumpsys for wifi debugging only
1687static void DumpstateWifiOnly() {
1688 DurationReporter duration_reporter("DUMPSTATE");
1689
1690 DumpstateRadioCommon();
1691
1692 printf("========================================================\n");
1693 printf("== Android Framework Services\n");
1694 printf("========================================================\n");
1695
1696 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1697 SEC_TO_MSEC(10));
1698 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1699 SEC_TO_MSEC(10));
1700
1701 printf("========================================================\n");
1702 printf("== dumpstate: done (id %d)\n", ds.id_);
1703 printf("========================================================\n");
1704}
1705
Nandana Duttcf419a72019-03-14 10:40:17 +00001706Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001707 DurationReporter duration_reporter("DUMP TRACES");
1708
1709 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1710 const size_t buf_size = temp_file_pattern.length() + 1;
1711 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1712 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1713
1714 // Create a new, empty file to receive all trace dumps.
1715 //
1716 // TODO: This can be simplified once we remove support for the old style
1717 // dumps. We can have a file descriptor passed in to dump_traces instead
1718 // of creating a file, closing it and then reopening it again.
1719 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1720 if (fd < 0) {
1721 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001722 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001723 }
1724
1725 // Nobody should have access to this temporary file except dumpstate, but we
1726 // temporarily grant 'read' to 'others' here because this file is created
1727 // when tombstoned is still running as root, but dumped after dropping. This
1728 // can go away once support for old style dumping has.
1729 const int chmod_ret = fchmod(fd, 0666);
1730 if (chmod_ret < 0) {
1731 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001732 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001733 }
1734
1735 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1736 if (proc.get() == nullptr) {
1737 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001738 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001739 }
1740
1741 // Number of times process dumping has timed out. If we encounter too many
1742 // failures, we'll give up.
1743 int timeout_failures = 0;
1744 bool dalvik_found = false;
1745
1746 const std::set<int> hal_pids = get_interesting_hal_pids();
1747
1748 struct dirent* d;
1749 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001750 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001751 int pid = atoi(d->d_name);
1752 if (pid <= 0) {
1753 continue;
1754 }
1755
1756 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1757 std::string exe;
1758 if (!android::base::Readlink(link_name, &exe)) {
1759 continue;
1760 }
1761
1762 bool is_java_process;
1763 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1764 // Don't bother dumping backtraces for the zygote.
1765 if (IsZygote(pid)) {
1766 continue;
1767 }
1768
1769 dalvik_found = true;
1770 is_java_process = true;
1771 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1772 is_java_process = false;
1773 } else {
1774 // Probably a native process we don't care about, continue.
1775 continue;
1776 }
1777
1778 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1779 if (timeout_failures == 3) {
1780 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1781 break;
1782 }
1783
1784 const uint64_t start = Nanotime();
1785 const int ret = dump_backtrace_to_file_timeout(
1786 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1787 is_java_process ? 5 : 20, fd);
1788
1789 if (ret == -1) {
1790 // For consistency, the header and footer to this message match those
1791 // dumped by debuggerd in the success case.
1792 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1793 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1794 dprintf(fd, "---- end %d ----", pid);
1795 timeout_failures++;
1796 continue;
1797 }
1798
1799 // We've successfully dumped stack traces, reset the failure count
1800 // and write a summary of the elapsed time to the file and continue with the
1801 // next process.
1802 timeout_failures = 0;
1803
1804 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1805 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1806 }
1807
1808 if (!dalvik_found) {
1809 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1810 }
1811
Nandana Duttcf419a72019-03-14 10:40:17 +00001812 *path = file_name_buf.release();
1813 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001814}
1815
Felipe Leme6f674ae2016-11-18 17:10:33 -08001816void Dumpstate::DumpstateBoard() {
1817 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001818 printf("========================================================\n");
1819 printf("== Board\n");
1820 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001821
Felipe Leme6f674ae2016-11-18 17:10:33 -08001822 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001823 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001824 return;
1825 }
1826
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001827 std::vector<std::string> paths;
1828 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001829 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001830 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1831 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001832 remover.emplace_back(android::base::make_scope_guard(
1833 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001834 }
Jie Song9fbfad02017-06-20 16:29:42 -07001835
Wei Wang587eac92018-04-05 12:17:20 -07001836 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1837 if (dumpstate_device == nullptr) {
1838 MYLOGE("No IDumpstateDevice implementation\n");
1839 return;
1840 }
1841
1842 using ScopedNativeHandle =
1843 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1844 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1845 [](native_handle_t* handle) {
1846 native_handle_close(handle);
1847 native_handle_delete(handle);
1848 });
1849 if (handle == nullptr) {
1850 MYLOGE("Could not create native_handle\n");
1851 return;
1852 }
1853
Nandana Dutt5c390032019-03-12 10:52:56 +00001854 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001855 for (size_t i = 0; i < paths.size(); i++) {
1856 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1857
1858 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1859 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1860 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1861 if (fd < 0) {
1862 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1863 return;
1864 }
1865 handle.get()->data[i] = fd.release();
1866 }
1867
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001868 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001869 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1870 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1871 // and grab whatever dumped
1872 std::packaged_task<bool()>
1873 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001874 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1875 if (!status.isOk()) {
1876 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001877 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001878 }
Wei Wang587eac92018-04-05 12:17:20 -07001879 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001880 });
Wei Wang587eac92018-04-05 12:17:20 -07001881
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001882 auto result = dumpstate_task.get_future();
1883 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001884
1885 constexpr size_t timeout_sec = 30;
1886 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1887 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1888 if (!android::base::SetProperty("ctl.interface_restart",
1889 android::base::StringPrintf("%s/default",
1890 IDumpstateDevice::descriptor))) {
1891 MYLOGE("Couldn't restart dumpstate HAL\n");
1892 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001893 }
Wei Wang587eac92018-04-05 12:17:20 -07001894 // Wait some time for init to kill dumpstate vendor HAL
1895 constexpr size_t killing_timeout_sec = 10;
1896 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1897 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1898 "there might be racing in content\n", killing_timeout_sec);
1899 }
1900
1901 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1902 for (size_t i = 0; i < paths.size(); i++) {
1903 struct stat s;
1904 if (fstat(handle.get()->data[i], &s) == -1) {
1905 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1906 strerror(errno));
1907 file_sizes[i] = -1;
1908 continue;
1909 }
1910 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001911 }
1912
1913 for (size_t i = 0; i < paths.size(); i++) {
1914 if (file_sizes[i] == -1) {
1915 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001916 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001917 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001918 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001919 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001920 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001921 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001922 }
1923
Felipe Lemed8b94e52016-12-08 10:21:44 -08001924 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001925}
1926
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001927static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001928 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001929 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Abhijeet Kaure370d682019-10-01 16:49:30 +01001930 "[-z]] [-s] [-S] [-q] [-P] [-R] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001931 " -h: display this help message\n"
1932 " -b: play sound file instead of vibrate, at beginning of job\n"
1933 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001934 " -d: append date to filename\n"
1935 " -p: capture screenshot to filename.png\n"
1936 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001937 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001938 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001939 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01001940 " -P: send broadcast when started and do progress updates\n"
1941 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001942 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001943 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001944}
1945
Wei Liuf87959e2016-08-26 14:51:42 -07001946static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001947 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001948}
1949
Felipe Leme1d486fe2016-10-14 18:06:47 -07001950bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001951 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001952 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001953 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001954 // Final timestamp
1955 char date[80];
1956 time_t the_real_now_please_stand_up = time(nullptr);
1957 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001958 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001959 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001960
Felipe Leme9a523ae2016-10-20 15:10:33 -07001961 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001962 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001963 return false;
1964 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001965 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001966 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001967 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001968 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001969
Felipe Leme0f3fb202016-06-10 17:10:53 -07001970 // Add log file (which contains stderr output) to zip...
1971 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001972 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001973 MYLOGE("Failed to add dumpstate log to .zip file\n");
1974 return false;
1975 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001976 // TODO: Should truncate the existing file.
1977 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001978 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1979 return false;
1980 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001981 fprintf(stderr, "\n");
1982
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001983 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001984 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001985 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001986 return false;
1987 }
1988
Felipe Leme1d486fe2016-10-14 18:06:47 -07001989 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1990 ds.zip_file.reset(nullptr);
1991
Felipe Lemee9d2c542016-11-15 11:48:26 -08001992 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001993 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001994
Felipe Leme1e9edc62015-12-21 16:02:13 -08001995 return true;
1996}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001997
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001998static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1999 // clang-format off
2000 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2001 "--receiver-foreground", "--receiver-include-background", "-a", action};
2002 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002003
2004 am.insert(am.end(), args.begin(), args.end());
2005
Felipe Leme8d2410e2017-02-08 09:46:08 -08002006 RunCommand("", am,
2007 CommandOptions::WithTimeout(20)
2008 .Log("Sending broadcast: '%s'\n")
2009 .Always()
2010 .DropRoot()
2011 .RedirectStderr()
2012 .Build());
2013}
2014
Felipe Leme35b8cf12017-02-10 15:47:29 -08002015static void Vibrate(int duration_ms) {
2016 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002017 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002018 CommandOptions::WithTimeout(10)
2019 .Log("Vibrate: '%s'\n")
2020 .Always()
2021 .Build());
2022 // clang-format on
2023}
2024
Nandana Dutt979388e2018-11-30 16:48:55 +00002025static void MaybeResolveSymlink(std::string* path) {
2026 std::string resolved_path;
2027 if (android::base::Readlink(*path, &resolved_path)) {
2028 *path = resolved_path;
2029 }
2030}
2031
Nandana Dutt4be45d12018-09-26 15:04:23 +01002032/*
2033 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2034 * if we are writing zip files and adds the version file.
2035 */
2036static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002037 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2038
Nandana Dutt4be45d12018-09-26 15:04:23 +01002039 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2040 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002041 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002042 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002043 char date[80];
2044 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2045 ds.name_ = date;
2046 } else {
2047 ds.name_ = "undated";
2048 }
2049
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002050 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002051 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002052 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002053 ds.base_name_ += "-wifi";
2054 }
2055
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002056 if (ds.options_->do_fb) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002057 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.png" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002058 }
2059 ds.tmp_path_ = ds.GetPath(".tmp");
2060 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2061
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002062 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002063 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002064 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002065 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002066 "Bugreport dir: [%s] "
2067 "Base name: [%s] "
2068 "Suffix: [%s] "
2069 "Log path: [%s] "
2070 "Temporary path: [%s] "
2071 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002072 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2073 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002074
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002075 if (ds.options_->do_zip_file) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002076 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.zip" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002077 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2078 create_parent_dirs(ds.path_.c_str());
2079 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2080 if (ds.zip_file == nullptr) {
2081 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2082 } else {
2083 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2084 }
2085 ds.AddTextZipEntry("version.txt", ds.version_);
2086 }
2087}
2088
2089/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002090 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002091 * printing zipped file status, etc.
2092 */
2093static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002094 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002095 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002096 if (!ds.FinishZipFile()) {
2097 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2098 do_text_file = true;
2099 } else {
2100 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002101 }
2102 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002103 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002104 if (do_text_file) {
2105 dprintf(ds.control_socket_fd_,
2106 "FAIL:could not create zip file, check %s "
2107 "for more details\n",
2108 ds.log_path_.c_str());
2109 } else {
2110 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2111 }
2112 }
2113}
2114
Nandana Dutt4be45d12018-09-26 15:04:23 +01002115
Nandana Dutt58d72e22018-11-16 10:30:48 +00002116static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2117 switch (mode) {
2118 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2119 return "BUGREPORT_FULL";
2120 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2121 return "BUGREPORT_INTERACTIVE";
2122 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2123 return "BUGREPORT_REMOTE";
2124 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2125 return "BUGREPORT_WEAR";
2126 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2127 return "BUGREPORT_TELEPHONY";
2128 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2129 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002130 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2131 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002132 }
2133}
2134
2135static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002136 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002137 switch (mode) {
2138 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Nandana Dutt58d72e22018-11-16 10:30:48 +00002139 options->do_fb = true;
2140 break;
2141 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002142 // Currently, the dumpstate binder is only used by Shell to update progress.
2143 options->do_start_service = true;
2144 options->do_progress_updates = true;
2145 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002146 break;
2147 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002148 options->do_vibrate = false;
2149 options->is_remote_mode = true;
2150 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002151 break;
2152 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002153 options->do_start_service = true;
2154 options->do_progress_updates = true;
2155 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002156 options->do_fb = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002157 break;
2158 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002159 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002160 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002161 break;
2162 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002163 options->wifi_only = true;
2164 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002165 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002166 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002167 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2168 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002169 }
2170}
2171
Nandana Dutt58d72e22018-11-16 10:30:48 +00002172static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002173 MYLOGI(
2174 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_fb: %d "
2175 "is_remote_mode: %d show_header_only: %d do_start_service: %d telephony_only: %d "
2176 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s args: %s\n",
2177 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
2178 options.do_fb, options.is_remote_mode, options.show_header_only, options.do_start_service,
2179 options.telephony_only, options.wifi_only, options.do_progress_updates,
2180 options.bugreport_fd.get(), options.bugreport_mode.c_str(), options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002181}
2182
Nandana Dutt54dbd672019-01-11 12:58:05 +00002183void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2184 const android::base::unique_fd& bugreport_fd_in,
2185 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002186 // In the new API world, date is always added; output is always a zip file.
2187 // TODO(111441001): remove these options once they are obsolete.
2188 do_add_date = true;
2189 do_zip_file = true;
2190
Nandana Dutt54dbd672019-01-11 12:58:05 +00002191 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2192 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2193 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002194
Nandana Dutt58d72e22018-11-16 10:30:48 +00002195 SetOptionsFromMode(bugreport_mode, this);
2196}
2197
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002198Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2199 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002200 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002201 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002202 switch (c) {
2203 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002204 case 'd': do_add_date = true; break;
2205 case 'z': do_zip_file = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002206 case 's': use_socket = true; break;
2207 case 'S': use_control_socket = true; break;
2208 case 'v': show_header_only = true; break;
2209 case 'q': do_vibrate = false; break;
2210 case 'p': do_fb = true; break;
2211 case 'P': do_progress_updates = true; break;
2212 case 'R': is_remote_mode = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002213 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002214 case 'w':
2215 // This was already processed
2216 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002217 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002218 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002219 break;
2220 default:
2221 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002222 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002223 break;
2224 // clang-format on
2225 }
2226 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002227
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002228 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002229 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002230 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002231 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002232 }
2233 }
2234
2235 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2236 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002237
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002238 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002239}
2240
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002241bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002242 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002243 return false;
2244 }
2245
Abhijeet Kaure370d682019-10-01 16:49:30 +01002246 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002247 return false;
2248 }
2249
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002250 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002251 return false;
2252 }
2253
Abhijeet Kaure370d682019-10-01 16:49:30 +01002254 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002255 return false;
2256 }
2257 return true;
2258}
2259
Nandana Dutt197661d2018-11-16 16:40:21 +00002260void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2261 options_ = std::move(options);
2262}
2263
Nandana Duttd2f5f082019-01-18 17:13:52 +00002264Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2265 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002266 if (listener_ != nullptr) {
2267 switch (status) {
2268 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002269 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002270 break;
2271 case Dumpstate::RunStatus::HELP:
2272 break;
2273 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002274 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002275 break;
2276 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002277 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2278 break;
2279 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2280 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2281 break;
2282 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2283 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002284 break;
2285 }
2286 }
2287 return status;
2288}
2289
Nandana Dutt979388e2018-11-30 16:48:55 +00002290/*
2291 * Dumps relevant information to a bugreport based on the given options.
2292 *
2293 * The bugreport can be dumped to a file or streamed to a socket.
2294 *
2295 * How dumping to file works:
2296 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2297 * stderr is redirected a log file.
2298 *
2299 * The temporary bugreport is then populated via printfs, dumping contents of files and
2300 * output of commands to stdout.
2301 *
2302 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2303 * text file.
2304 *
2305 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2306 * gets added to the archive.
2307 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002308 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2309 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002310 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002311Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2312 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002313 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002314 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002315 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002316 return RunStatus::INVALID_INPUT;
2317 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002318 /* set as high priority, and protect from OOM killer */
2319 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002320
Felipe Lemed071c682016-10-20 16:48:00 -07002321 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002322 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002323 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002324 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002325 } else {
2326 /* fallback to kernels <= 2.6.35 */
2327 oom_adj = fopen("/proc/self/oom_adj", "we");
2328 if (oom_adj) {
2329 fputs("-17", oom_adj);
2330 fclose(oom_adj);
2331 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002332 }
2333
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002334 if (version_ == VERSION_DEFAULT) {
2335 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002336 }
2337
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002338 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002339 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002340 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002341 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002342 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002343 }
2344
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002345 if (options_->show_header_only) {
2346 PrintHeader();
2347 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002348 }
2349
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002350 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2351 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002352
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002353 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002354 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002355
2356 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002357 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002358 is_redirecting
2359 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2360 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002361 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002362
Felipe Lemed071c682016-10-20 16:48:00 -07002363 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002364 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002365 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002366 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2367
Sahana Raof35ed432019-07-12 10:47:52 +01002368 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2369 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2370 } else {
2371 // Wake lock will be released automatically on process death
2372 MYLOGD("Wake lock acquired.\n");
2373 }
2374
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002375 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002376
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002377 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002378 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002379 MYLOGI("Starting 'dumpstate' service\n");
2380 android::status_t ret;
2381 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2382 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2383 }
2384 }
2385
Felipe Lemef0292972016-11-22 13:57:05 -08002386 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002387 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2388 }
2389
Nandana Dutt235c6672019-11-14 15:22:32 +00002390 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2391 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002392
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002393 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002394
Christopher Ferrised9354f2014-10-01 17:35:01 -07002395 // If we are going to use a socket, do it as early as possible
2396 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002397 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002398 if (!redirect_to_socket(stdout, "dumpstate")) {
2399 return ERROR;
2400 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002401 }
2402
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002403 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002404 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002405 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002406 if (control_socket_fd_ == -1) {
2407 return ERROR;
2408 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002409 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002410 }
2411
Felipe Leme71bbfc52015-11-23 14:14:51 -08002412 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002413 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002414
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002415 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002416 // clang-format off
2417 std::vector<std::string> am_args = {
2418 "--receiver-permission", "android.permission.DUMP",
2419 };
2420 // clang-format on
2421 // Send STARTED broadcast for apps that listen to bugreport generation events
2422 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002423 if (options_->use_control_socket) {
2424 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002425 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002426 }
2427 }
2428
Nick Kralevichf3599b32016-01-25 15:05:16 -08002429 /* read /proc/cmdline before dropping root */
2430 FILE *cmdline = fopen("/proc/cmdline", "re");
2431 if (cmdline) {
2432 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2433 fclose(cmdline);
2434 }
2435
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002436 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002437 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002438 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002439
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002440 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002441 MYLOGI("taking early screenshot\n");
2442 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002443 }
2444
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002445 if (options_->do_zip_file && zip_file != nullptr) {
2446 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2447 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002448 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002449 }
2450 }
2451
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002452 int dup_stdout_fd;
2453 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002454 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002455 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002456 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002457 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2458 return ERROR;
2459 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002460 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2461 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2462 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002463 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002464
2465 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2466 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002467 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002468 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002469 /* TODO: rather than generating a text file now and zipping it later,
2470 it would be more efficient to redirect stdout to the zip entry
2471 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002472 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2473 return ERROR;
2474 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002475 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002476 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002477 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002478 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002479 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002480
2481 // Don't buffer stdout
2482 setvbuf(stdout, nullptr, _IONBF, 0);
2483
Felipe Leme608385d2016-02-01 10:35:38 -08002484 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2485 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002486 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002487 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002488
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002489 if (options_->telephony_only) {
Jichao Lie89d9c12019-11-21 19:02:51 -08002490 MaybeCheckUserConsent(calling_uid, calling_package);
Jayachandran Ca94c7172017-06-10 15:08:12 -07002491 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002492 DumpstateBoard();
2493 } else if (options_->wifi_only) {
Jichao Lie89d9c12019-11-21 19:02:51 -08002494 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002495 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002496 } else {
Jichao Lie89d9c12019-11-21 19:02:51 -08002497 // Invoking the critical dumpsys calls before DumpTraces() to try and
2498 // keep the system stats as close to its initial state as possible.
2499 RunDumpsysCritical();
2500
2501 // Run consent check only after critical dumpsys has finished -- so the consent
2502 // isn't going to pollute the system state / logs.
2503 MaybeCheckUserConsent(calling_uid, calling_package);
2504
Nandana Dutt4be45d12018-09-26 15:04:23 +01002505 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002506 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002507 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002508 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002509 HandleUserConsentDenied();
2510 }
2511 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002512 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002513 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002514
Felipe Leme55b42a62015-11-10 17:39:08 -08002515 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002516 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002517 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002518 }
2519
Abhijeet Kaure370d682019-10-01 16:49:30 +01002520 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002521 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002522 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002523 }
2524
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002525 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002526 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002527 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002528 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002529 if (status != Dumpstate::RunStatus::OK &&
2530 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2531 // Do an early return if there were errors. We make an exception for consent
2532 // timing out because it's possible the user got distracted. In this case the
2533 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002534 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002535 return status;
2536 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002537 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002538 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2539 options_->screenshot_fd.get());
2540 if (copy_succeeded) {
2541 android::os::UnlinkAndLogOnError(screenshot_path_);
2542 }
2543 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002544 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2545 MYLOGI(
2546 "Did not receive user consent yet."
2547 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002548 const String16 incidentcompanion("incidentcompanion");
2549 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2550 if (ics != nullptr) {
2551 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2552 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2553 consent_callback_.get());
2554 } else {
2555 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2556 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002557 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002558 }
2559
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002560 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002561 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002562 for (int i = 0; i < 3; i++) {
2563 Vibrate(75);
2564 usleep((75 + 50) * 1000);
2565 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002566 }
2567
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002568 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2569 progress_->GetInitialMax());
2570 progress_->Save();
2571 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002572
Felipe Leme107a05f2016-03-08 15:11:15 -08002573 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002574 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002575 }
2576
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002577 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002578 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002579 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002580 }
2581
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002582 tombstone_data_.clear();
2583 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002584
Nandana Duttd2f5f082019-01-18 17:13:52 +00002585 return (consent_callback_ != nullptr &&
2586 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2587 ? USER_CONSENT_TIMED_OUT
2588 : RunStatus::OK;
2589}
2590
Jichao Lie89d9c12019-11-21 19:02:51 -08002591void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
2592 if (calling_uid == AID_SHELL || !CalledByApi()) {
2593 // No need to get consent for shell triggered dumpstates, or not through
2594 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002595 return;
2596 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002597 consent_callback_ = new ConsentCallback();
2598 const String16 incidentcompanion("incidentcompanion");
2599 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08002600 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002601 if (ics != nullptr) {
2602 MYLOGD("Checking user consent via incidentcompanion service\n");
2603 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08002604 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07002605 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002606 } else {
2607 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2608 }
2609}
2610
Nandana Dutt5c390032019-03-12 10:52:56 +00002611bool Dumpstate::IsUserConsentDenied() const {
2612 return ds.consent_callback_ != nullptr &&
2613 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2614}
2615
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002616bool Dumpstate::CalledByApi() const {
2617 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2618}
2619
Nandana Duttd2f5f082019-01-18 17:13:52 +00002620void Dumpstate::CleanupFiles() {
2621 android::os::UnlinkAndLogOnError(tmp_path_);
2622 android::os::UnlinkAndLogOnError(screenshot_path_);
2623 android::os::UnlinkAndLogOnError(path_);
2624}
2625
2626Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2627 MYLOGD("User denied consent; deleting files and returning\n");
2628 CleanupFiles();
2629 return USER_CONSENT_DENIED;
2630}
2631
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002632Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002633 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002634 // user consent (unless the caller is Shell).
2635 UserConsentResult consent_result;
2636 if (calling_uid == AID_SHELL) {
2637 consent_result = UserConsentResult::APPROVED;
2638 } else {
2639 consent_result = consent_callback_->getResult();
2640 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002641 if (consent_result == UserConsentResult::UNAVAILABLE) {
2642 // User has not responded yet.
2643 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2644 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2645 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2646 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2647 sleep(delay_seconds);
2648 }
2649 consent_result = consent_callback_->getResult();
2650 }
2651 if (consent_result == UserConsentResult::DENIED) {
2652 // User has explicitly denied sharing with the app. To be safe delete the
2653 // internal bugreport & tmp files.
2654 return HandleUserConsentDenied();
2655 }
2656 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002657 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2658 if (copy_succeeded) {
2659 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002660 }
2661 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2662 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2663 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2664 // Since we do not have user consent to share the bugreport it does not get
2665 // copied over to the calling app but remains in the internal directory from
2666 // where the user can manually pull it.
2667 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2668 }
2669 // Unknown result; must be a programming error.
2670 MYLOGE("Unknown user consent result:%d\n", consent_result);
2671 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002672}
2673
Nandana Duttf02564e2019-02-15 15:24:24 +00002674Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002675 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2676 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2677 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002678 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002679 // When directly running dumpstate binary, the output is not expected to be written
2680 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002681 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002682
2683 // calling_uid and calling_package are for user consent to share the bugreport with
2684 // an app; they are irrelvant here because bugreport is only written to a local
2685 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002686 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002687 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002688 return status;
2689}
2690
2691/* Main entry point for dumpstate binary. */
2692int run_main(int argc, char* argv[]) {
2693 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002694
2695 switch (status) {
2696 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002697 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002698 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002699 ShowUsage();
2700 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002701 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002702 fprintf(stderr, "Invalid combination of args\n");
2703 ShowUsage();
2704 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002705 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002706 FALLTHROUGH_INTENDED;
2707 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2708 FALLTHROUGH_INTENDED;
2709 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002710 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002711 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002712}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002713
2714// TODO(111441001): Default DumpOptions to sensible values.
2715Dumpstate::Dumpstate(const std::string& version)
2716 : pid_(getpid()),
2717 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01002718 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002719 version_(version),
2720 now_(time(nullptr)) {
2721}
2722
2723Dumpstate& Dumpstate::GetInstance() {
2724 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2725 return singleton_;
2726}
2727
Nandana Dutt8d945c02019-08-14 13:30:07 +01002728DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2729 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002730 if (!title_.empty()) {
2731 started_ = Nanotime();
2732 }
2733}
2734
2735DurationReporter::~DurationReporter() {
2736 if (!title_.empty()) {
2737 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002738 if (elapsed >= .5f || verbose_) {
2739 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002740 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002741 if (!logcat_only_) {
2742 // Use "Yoda grammar" to make it easier to grep|sort sections.
2743 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002744 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002745 }
2746}
2747
2748const int32_t Progress::kDefaultMax = 5000;
2749
2750Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2751}
2752
2753Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2754 : Progress(initial_max, growth_factor, "") {
2755 progress_ = progress;
2756}
2757
2758Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2759 : initial_max_(initial_max),
2760 progress_(0),
2761 max_(initial_max),
2762 growth_factor_(growth_factor),
2763 n_runs_(0),
2764 average_max_(0),
2765 path_(path) {
2766 if (!path_.empty()) {
2767 Load();
2768 }
2769}
2770
2771void Progress::Load() {
2772 MYLOGD("Loading stats from %s\n", path_.c_str());
2773 std::string content;
2774 if (!android::base::ReadFileToString(path_, &content)) {
2775 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2776 return;
2777 }
2778 if (content.empty()) {
2779 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2780 return;
2781 }
2782 std::vector<std::string> lines = android::base::Split(content, "\n");
2783
2784 if (lines.size() < 1) {
2785 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2786 (int)lines.size(), max_);
2787 return;
2788 }
2789 char* ptr;
2790 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2791 average_max_ = strtol(ptr, nullptr, 10);
2792 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2793 average_max_ > STATS_MAX_AVERAGE) {
2794 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2795 initial_max_ = Progress::kDefaultMax;
2796 } else {
2797 initial_max_ = average_max_;
2798 }
2799 max_ = initial_max_;
2800
2801 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2802}
2803
2804void Progress::Save() {
2805 int32_t total = n_runs_ * average_max_ + progress_;
2806 int32_t runs = n_runs_ + 1;
2807 int32_t average = floor(((float)total) / runs);
2808 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2809 path_.c_str());
2810 if (path_.empty()) {
2811 return;
2812 }
2813
2814 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2815 if (!android::base::WriteStringToFile(content, path_)) {
2816 MYLOGE("Could not save stats on %s\n", path_.c_str());
2817 }
2818}
2819
2820int32_t Progress::Get() const {
2821 return progress_;
2822}
2823
2824bool Progress::Inc(int32_t delta_sec) {
2825 bool changed = false;
2826 if (delta_sec >= 0) {
2827 progress_ += delta_sec;
2828 if (progress_ > max_) {
2829 int32_t old_max = max_;
2830 max_ = floor((float)progress_ * growth_factor_);
2831 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
2832 changed = true;
2833 }
2834 }
2835 return changed;
2836}
2837
2838int32_t Progress::GetMax() const {
2839 return max_;
2840}
2841
2842int32_t Progress::GetInitialMax() const {
2843 return initial_max_;
2844}
2845
2846void Progress::Dump(int fd, const std::string& prefix) const {
2847 const char* pr = prefix.c_str();
2848 dprintf(fd, "%sprogress: %d\n", pr, progress_);
2849 dprintf(fd, "%smax: %d\n", pr, max_);
2850 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
2851 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
2852 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
2853 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
2854 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
2855}
2856
2857bool Dumpstate::IsZipping() const {
2858 return zip_writer_ != nullptr;
2859}
2860
2861std::string Dumpstate::GetPath(const std::string& suffix) const {
2862 return GetPath(bugreport_internal_dir_, suffix);
2863}
2864
2865std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
2866 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
2867 name_.c_str(), suffix.c_str());
2868}
2869
2870void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
2871 progress_ = std::move(progress);
2872}
2873
2874void for_each_userid(void (*func)(int), const char *header) {
2875 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
2876 "for_each_userid(%s)", header);
2877 DurationReporter duration_reporter(title);
2878 if (PropertiesHelper::IsDryRun()) return;
2879
2880 DIR *d;
2881 struct dirent *de;
2882
2883 if (header) printf("\n------ %s ------\n", header);
2884 func(0);
2885
2886 if (!(d = opendir("/data/system/users"))) {
2887 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
2888 return;
2889 }
2890
2891 while ((de = readdir(d))) {
2892 int userid;
2893 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
2894 continue;
2895 }
2896 func(userid);
2897 }
2898
2899 closedir(d);
2900}
2901
2902static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
2903 DIR *d;
2904 struct dirent *de;
2905
2906 if (!(d = opendir("/proc"))) {
2907 printf("Failed to open /proc (%s)\n", strerror(errno));
2908 return;
2909 }
2910
2911 if (header) printf("\n------ %s ------\n", header);
2912 while ((de = readdir(d))) {
2913 if (ds.IsUserConsentDenied()) {
2914 MYLOGE(
2915 "Returning early because user denied consent to share bugreport with calling app.");
2916 closedir(d);
2917 return;
2918 }
2919 int pid;
2920 int fd;
2921 char cmdpath[255];
2922 char cmdline[255];
2923
2924 if (!(pid = atoi(de->d_name))) {
2925 continue;
2926 }
2927
2928 memset(cmdline, 0, sizeof(cmdline));
2929
2930 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
2931 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2932 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
2933 close(fd);
2934 if (cmdline[0]) {
2935 helper(pid, cmdline, arg);
2936 continue;
2937 }
2938 }
2939
2940 // if no cmdline, a kernel thread has comm
2941 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
2942 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2943 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
2944 close(fd);
2945 if (cmdline[1]) {
2946 cmdline[0] = '[';
2947 size_t len = strcspn(cmdline, "\f\b\r\n");
2948 cmdline[len] = ']';
2949 cmdline[len+1] = '\0';
2950 }
2951 }
2952 if (!cmdline[0]) {
2953 strcpy(cmdline, "N/A");
2954 }
2955 helper(pid, cmdline, arg);
2956 }
2957
2958 closedir(d);
2959}
2960
2961static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
2962 for_each_pid_func *func = (for_each_pid_func*) arg;
2963 func(pid, cmdline);
2964}
2965
2966void for_each_pid(for_each_pid_func func, const char *header) {
2967 std::string title = header == nullptr ? "for_each_pid"
2968 : android::base::StringPrintf("for_each_pid(%s)", header);
2969 DurationReporter duration_reporter(title);
2970 if (PropertiesHelper::IsDryRun()) return;
2971
2972 __for_each_pid(for_each_pid_helper, header, (void *) func);
2973}
2974
2975static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
2976 DIR *d;
2977 struct dirent *de;
2978 char taskpath[255];
2979 for_each_tid_func *func = (for_each_tid_func *) arg;
2980
2981 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
2982
2983 if (!(d = opendir(taskpath))) {
2984 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
2985 return;
2986 }
2987
2988 func(pid, pid, cmdline);
2989
2990 while ((de = readdir(d))) {
2991 if (ds.IsUserConsentDenied()) {
2992 MYLOGE(
2993 "Returning early because user denied consent to share bugreport with calling app.");
2994 closedir(d);
2995 return;
2996 }
2997 int tid;
2998 int fd;
2999 char commpath[255];
3000 char comm[255];
3001
3002 if (!(tid = atoi(de->d_name))) {
3003 continue;
3004 }
3005
3006 if (tid == pid)
3007 continue;
3008
3009 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3010 memset(comm, 0, sizeof(comm));
3011 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3012 strcpy(comm, "N/A");
3013 } else {
3014 char *c;
3015 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3016 close(fd);
3017
3018 c = strrchr(comm, '\n');
3019 if (c) {
3020 *c = '\0';
3021 }
3022 }
3023 func(pid, tid, comm);
3024 }
3025
3026 closedir(d);
3027}
3028
3029void for_each_tid(for_each_tid_func func, const char *header) {
3030 std::string title = header == nullptr ? "for_each_tid"
3031 : android::base::StringPrintf("for_each_tid(%s)", header);
3032 DurationReporter duration_reporter(title);
3033
3034 if (PropertiesHelper::IsDryRun()) return;
3035
3036 __for_each_pid(for_each_tid_helper, header, (void *) func);
3037}
3038
3039void show_wchan(int pid, int tid, const char *name) {
3040 if (PropertiesHelper::IsDryRun()) return;
3041
3042 char path[255];
3043 char buffer[255];
3044 int fd, ret, save_errno;
3045 char name_buffer[255];
3046
3047 memset(buffer, 0, sizeof(buffer));
3048
3049 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3050 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3051 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3052 return;
3053 }
3054
3055 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3056 save_errno = errno;
3057 close(fd);
3058
3059 if (ret < 0) {
3060 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3061 return;
3062 }
3063
3064 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3065 pid == tid ? 0 : 3, "", name);
3066
3067 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3068
3069 return;
3070}
3071
3072// print time in centiseconds
3073static void snprcent(char *buffer, size_t len, size_t spc,
3074 unsigned long long time) {
3075 static long hz; // cache discovered hz
3076
3077 if (hz <= 0) {
3078 hz = sysconf(_SC_CLK_TCK);
3079 if (hz <= 0) {
3080 hz = 1000;
3081 }
3082 }
3083
3084 // convert to centiseconds
3085 time = (time * 100 + (hz / 2)) / hz;
3086
3087 char str[16];
3088
3089 snprintf(str, sizeof(str), " %llu.%02u",
3090 time / 100, (unsigned)(time % 100));
3091 size_t offset = strlen(buffer);
3092 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3093 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3094}
3095
3096// print permille as a percent
3097static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3098 char str[16];
3099
3100 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3101 size_t offset = strlen(buffer);
3102 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3103 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3104}
3105
3106void show_showtime(int pid, const char *name) {
3107 if (PropertiesHelper::IsDryRun()) return;
3108
3109 char path[255];
3110 char buffer[1023];
3111 int fd, ret, save_errno;
3112
3113 memset(buffer, 0, sizeof(buffer));
3114
3115 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3116 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3117 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3118 return;
3119 }
3120
3121 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3122 save_errno = errno;
3123 close(fd);
3124
3125 if (ret < 0) {
3126 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3127 return;
3128 }
3129
3130 // field 14 is utime
3131 // field 15 is stime
3132 // field 42 is iotime
3133 unsigned long long utime = 0, stime = 0, iotime = 0;
3134 if (sscanf(buffer,
3135 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3136 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3137 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3138 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3139 &utime, &stime, &iotime) != 3) {
3140 return;
3141 }
3142
3143 unsigned long long total = utime + stime;
3144 if (!total) {
3145 return;
3146 }
3147
3148 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3149 if (permille > 1000) {
3150 permille = 1000;
3151 }
3152
3153 // try to beautify and stabilize columns at <80 characters
3154 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3155 if ((name[0] != '[') || utime) {
3156 snprcent(buffer, sizeof(buffer), 57, utime);
3157 }
3158 snprcent(buffer, sizeof(buffer), 65, stime);
3159 if ((name[0] != '[') || iotime) {
3160 snprcent(buffer, sizeof(buffer), 73, iotime);
3161 }
3162 if (iotime) {
3163 snprdec(buffer, sizeof(buffer), 79, permille);
3164 }
3165 puts(buffer); // adds a trailing newline
3166
3167 return;
3168}
3169
3170void do_dmesg() {
3171 const char *title = "KERNEL LOG (dmesg)";
3172 DurationReporter duration_reporter(title);
3173 printf("------ %s ------\n", title);
3174
3175 if (PropertiesHelper::IsDryRun()) return;
3176
3177 /* Get size of kernel buffer */
3178 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3179 if (size <= 0) {
3180 printf("Unexpected klogctl return value: %d\n\n", size);
3181 return;
3182 }
3183 char *buf = (char *) malloc(size + 1);
3184 if (buf == nullptr) {
3185 printf("memory allocation failed\n\n");
3186 return;
3187 }
3188 int retval = klogctl(KLOG_READ_ALL, buf, size);
3189 if (retval < 0) {
3190 printf("klogctl failure\n\n");
3191 free(buf);
3192 return;
3193 }
3194 buf[retval] = '\0';
3195 printf("%s\n\n", buf);
3196 free(buf);
3197 return;
3198}
3199
3200void do_showmap(int pid, const char *name) {
3201 char title[255];
3202 char arg[255];
3203
3204 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3205 snprintf(arg, sizeof(arg), "%d", pid);
3206 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3207}
3208
3209int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3210 DurationReporter duration_reporter(title);
3211
3212 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3213
3214 UpdateProgress(WEIGHT_FILE);
3215
3216 return status;
3217}
3218
3219int read_file_as_long(const char *path, long int *output) {
3220 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3221 if (fd < 0) {
3222 int err = errno;
3223 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3224 return -1;
3225 }
3226 char buffer[50];
3227 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3228 if (bytes_read == -1) {
3229 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3230 return -2;
3231 }
3232 if (bytes_read == 0) {
3233 MYLOGE("File %s is empty\n", path);
3234 return -3;
3235 }
3236 *output = atoi(buffer);
3237 return 0;
3238}
3239
3240/* calls skip to gate calling dump_from_fd recursively
3241 * in the specified directory. dump_from_fd defaults to
3242 * dump_file_from_fd above when set to NULL. skip defaults
3243 * to false when set to NULL. dump_from_fd will always be
3244 * called with title NULL.
3245 */
3246int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3247 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3248 DurationReporter duration_reporter(title);
3249 DIR *dirp;
3250 struct dirent *d;
3251 char *newpath = nullptr;
3252 const char *slash = "/";
3253 int retval = 0;
3254
3255 if (!title.empty()) {
3256 printf("------ %s (%s) ------\n", title.c_str(), dir);
3257 }
3258 if (PropertiesHelper::IsDryRun()) return 0;
3259
3260 if (dir[strlen(dir) - 1] == '/') {
3261 ++slash;
3262 }
3263 dirp = opendir(dir);
3264 if (dirp == nullptr) {
3265 retval = -errno;
3266 MYLOGE("%s: %s\n", dir, strerror(errno));
3267 return retval;
3268 }
3269
3270 if (!dump_from_fd) {
3271 dump_from_fd = dump_file_from_fd;
3272 }
3273 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3274 if ((d->d_name[0] == '.')
3275 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3276 || (d->d_name[1] == '\0'))) {
3277 continue;
3278 }
3279 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3280 (d->d_type == DT_DIR) ? "/" : "");
3281 if (!newpath) {
3282 retval = -errno;
3283 continue;
3284 }
3285 if (skip && (*skip)(newpath)) {
3286 continue;
3287 }
3288 if (d->d_type == DT_DIR) {
3289 int ret = dump_files("", newpath, skip, dump_from_fd);
3290 if (ret < 0) {
3291 retval = ret;
3292 }
3293 continue;
3294 }
3295 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3296 if (fd.get() < 0) {
3297 retval = -1;
3298 printf("*** %s: %s\n", newpath, strerror(errno));
3299 continue;
3300 }
3301 (*dump_from_fd)(nullptr, newpath, fd.get());
3302 }
3303 closedir(dirp);
3304 if (!title.empty()) {
3305 printf("\n");
3306 }
3307 return retval;
3308}
3309
3310/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3311 * it's possible to avoid issues where opening the file itself can get
3312 * stuck.
3313 */
3314int dump_file_from_fd(const char *title, const char *path, int fd) {
3315 if (PropertiesHelper::IsDryRun()) return 0;
3316
3317 int flags = fcntl(fd, F_GETFL);
3318 if (flags == -1) {
3319 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3320 return -1;
3321 } else if (!(flags & O_NONBLOCK)) {
3322 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3323 return -1;
3324 }
3325 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3326}
3327
3328int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003329 const CommandOptions& options, bool verbose_duration) {
3330 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003331
3332 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3333
3334 /* TODO: for now we're simplifying the progress calculation by using the
3335 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3336 * where its weight should be much higher proportionally to its timeout.
3337 * Ideally, it should use a options.EstimatedDuration() instead...*/
3338 UpdateProgress(options.Timeout());
3339
3340 return status;
3341}
3342
3343void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3344 const CommandOptions& options, long dumpsysTimeoutMs) {
3345 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3346 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3347 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3348 RunCommand(title, dumpsys, options);
3349}
3350
3351int open_socket(const char *service) {
3352 int s = android_get_control_socket(service);
3353 if (s < 0) {
3354 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3355 return -1;
3356 }
3357 fcntl(s, F_SETFD, FD_CLOEXEC);
3358
3359 // Set backlog to 0 to make sure that queue size will be minimum.
3360 // In Linux, because the minimum queue will be 1, connect() will be blocked
3361 // if the other clients already called connect() and the connection request was not accepted.
3362 if (listen(s, 0) < 0) {
3363 MYLOGE("listen(control socket): %s\n", strerror(errno));
3364 return -1;
3365 }
3366
3367 struct sockaddr addr;
3368 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003369 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003370
3371 // Close socket just after accept(), to make sure that connect() by client will get error
3372 // when the socket is used by the other services.
3373 // There is still a race condition possibility between accept and close, but there is no way
3374 // to close-on-accept atomically.
3375 // See detail; b/123306389#comment25
3376 close(s);
3377
3378 if (fd < 0) {
3379 MYLOGE("accept(control socket): %s\n", strerror(errno));
3380 return -1;
3381 }
3382
3383 return fd;
3384}
3385
3386/* redirect output to a service control socket */
3387bool redirect_to_socket(FILE* redirect, const char* service) {
3388 int fd = open_socket(service);
3389 if (fd == -1) {
3390 return false;
3391 }
3392 fflush(redirect);
3393 // TODO: handle dup2 failure
3394 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3395 close(fd);
3396 return true;
3397}
3398
3399// TODO: should call is_valid_output_file and/or be merged into it.
3400void create_parent_dirs(const char *path) {
3401 char *chp = const_cast<char *> (path);
3402
3403 /* skip initial slash */
3404 if (chp[0] == '/')
3405 chp++;
3406
3407 /* create leading directories, if necessary */
3408 struct stat dir_stat;
3409 while (chp && chp[0]) {
3410 chp = strchr(chp, '/');
3411 if (chp) {
3412 *chp = 0;
3413 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3414 MYLOGI("Creating directory %s\n", path);
3415 if (mkdir(path, 0770)) { /* drwxrwx--- */
3416 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3417 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3418 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3419 }
3420 }
3421 *chp++ = '/';
3422 }
3423 }
3424}
3425
3426bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3427 create_parent_dirs(path);
3428
3429 int fd = TEMP_FAILURE_RETRY(open(path,
3430 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3431 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3432 if (fd < 0) {
3433 MYLOGE("%s: %s\n", path, strerror(errno));
3434 return false;
3435 }
3436
3437 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3438 close(fd);
3439 return true;
3440}
3441
3442bool redirect_to_file(FILE* redirect, char* path) {
3443 return _redirect_to_file(redirect, path, O_TRUNC);
3444}
3445
3446bool redirect_to_existing_file(FILE* redirect, char* path) {
3447 return _redirect_to_file(redirect, path, O_APPEND);
3448}
3449
3450void dump_route_tables() {
3451 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3452 if (PropertiesHelper::IsDryRun()) return;
3453 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3454 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3455 FILE* fp = fopen(RT_TABLES_PATH, "re");
3456 if (!fp) {
3457 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3458 return;
3459 }
3460 char table[16];
3461 // Each line has an integer (the table number), a space, and a string (the table name). We only
3462 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3463 // Add a fixed max limit so this doesn't go awry.
3464 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3465 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3466 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3467 }
3468 fclose(fp);
3469}
3470
3471// TODO: make this function thread safe if sections are generated in parallel.
3472void Dumpstate::UpdateProgress(int32_t delta_sec) {
3473 if (progress_ == nullptr) {
3474 MYLOGE("UpdateProgress: progress_ not set\n");
3475 return;
3476 }
3477
3478 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01003479 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003480
3481 // ...but only notifiy listeners when necessary.
3482 if (!options_->do_progress_updates) return;
3483
3484 int progress = progress_->Get();
3485 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01003486 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003487
Nandana Dutt402a8392019-06-14 14:25:13 +01003488 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003489 return;
3490 }
Nandana Dutt402a8392019-06-14 14:25:13 +01003491 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003492
3493 if (control_socket_fd_ >= 0) {
3494 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3495 fsync(control_socket_fd_);
3496 }
3497
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003498 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003499 if (percent % 10 == 0) {
3500 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003501 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003502 } else {
3503 // stderr is ignored on normal invocations, but useful when calling
3504 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003505 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003506 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003507
3508 listener_->onProgress(percent);
3509 }
3510}
3511
3512void Dumpstate::TakeScreenshot(const std::string& path) {
3513 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3514 int status =
3515 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3516 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3517 if (status == 0) {
3518 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3519 } else {
3520 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3521 }
3522}
3523
3524bool is_dir(const char* pathname) {
3525 struct stat info;
3526 if (stat(pathname, &info) == -1) {
3527 return false;
3528 }
3529 return S_ISDIR(info.st_mode);
3530}
3531
3532time_t get_mtime(int fd, time_t default_mtime) {
3533 struct stat info;
3534 if (fstat(fd, &info) == -1) {
3535 return default_mtime;
3536 }
3537 return info.st_mtime;
3538}