blob: 8371e3cf6f5c95ba5836aed4f17ffe5e4413c5c0 [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"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700158
Narayan Kamath8f788292017-05-25 13:20:39 +0100159// TODO(narayan): Since this information has to be kept in sync
160// with tombstoned, we should just put it in a common header.
161//
162// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100163static const std::string TOMBSTONE_DIR = "/data/tombstones/";
164static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
165static const std::string ANR_DIR = "/data/anr/";
166static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700167
Felipe Lemee844a9d2016-09-21 15:01:39 -0700168// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000169
Nandana Dutt5c390032019-03-12 10:52:56 +0000170#define RETURN_IF_USER_DENIED_CONSENT() \
171 if (ds.IsUserConsentDenied()) { \
172 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
173 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
174 }
175
176// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
177// if consent is found to be denied.
178#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
179 RETURN_IF_USER_DENIED_CONSENT(); \
180 func_ptr(__VA_ARGS__); \
181 RETURN_IF_USER_DENIED_CONSENT();
182
Sahana Raof35ed432019-07-12 10:47:52 +0100183static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
184
Nandana Dutt979388e2018-11-30 16:48:55 +0000185namespace android {
186namespace os {
187namespace {
188
189static int Open(std::string path, int flags, mode_t mode = 0) {
190 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
191 if (fd == -1) {
192 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
193 }
194 return fd;
195}
196
Nandana Dutt979388e2018-11-30 16:48:55 +0000197
198static int OpenForRead(std::string path) {
199 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
200}
201
202bool CopyFile(int in_fd, int out_fd) {
203 char buf[4096];
204 ssize_t byte_count;
205 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
206 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
207 return false;
208 }
209 }
210 return (byte_count != -1);
211}
212
213static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000214 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000215
216 // Obtain a handle to the source file.
217 android::base::unique_fd in_fd(OpenForRead(input_file));
218 if (out_fd != -1 && in_fd.get() != -1) {
219 if (CopyFile(in_fd.get(), out_fd)) {
220 return true;
221 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000222 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000223 }
224 return false;
225}
226
Nandana Duttd2f5f082019-01-18 17:13:52 +0000227static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000228 if (unlink(file.c_str())) {
229 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000230 return false;
231 }
232 return true;
233}
Nandana Dutt979388e2018-11-30 16:48:55 +0000234
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000235
Nikita Ioffea325a572019-05-16 19:49:47 +0100236int64_t GetModuleMetadataVersion() {
237 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
238 if (binder == nullptr) {
239 MYLOGE("Failed to retrieve package_native service");
240 return 0L;
241 }
242 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
243 std::string package_name;
244 auto status = package_service->getModuleMetadataPackageName(&package_name);
245 if (!status.isOk()) {
246 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
247 return 0L;
248 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100249 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100250 int64_t version_code;
251 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
252 &version_code);
253 if (!status.isOk()) {
254 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
255 return 0L;
256 }
257 return version_code;
258}
259
Nandana Dutt979388e2018-11-30 16:48:55 +0000260} // namespace
261} // namespace os
262} // namespace android
263
Felipe Leme678727a2016-09-21 17:22:11 -0700264static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800265 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800266 long dumpsysTimeoutMs = 0) {
267 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700268}
269static int DumpFile(const std::string& title, const std::string& path) {
270 return ds.DumpFile(title, path);
271}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800272
Felipe Lemee844a9d2016-09-21 15:01:39 -0700273// Relative directory (inside the zip) for all files copied as-is into the bugreport.
274static const std::string ZIP_ROOT_DIR = "FS";
275
Vishnu Naire97d6122018-01-18 13:58:56 -0800276static const std::string kProtoPath = "proto/";
277static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700278static const std::string kDumpstateBoardFiles[] = {
279 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700280 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700281};
282static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
283
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700284static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700285static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700286
Felipe Lemef0292972016-11-22 13:57:05 -0800287static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
288
Narayan Kamath8f788292017-05-25 13:20:39 +0100289/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100290 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
291 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
292 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100293 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700294static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
295 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700296 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100297 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
298
Narayan Kamathbd863722017-06-01 18:50:12 +0100299 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100300
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700301 if (dump_dir == nullptr) {
302 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700303 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700304 }
305
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700306 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100307 struct dirent* entry = nullptr;
308 while ((entry = readdir(dump_dir.get()))) {
309 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100310 continue;
311 }
312
Narayan Kamathbd863722017-06-01 18:50:12 +0100313 const std::string base_name(entry->d_name);
314 if (base_name.find(file_prefix) != 0) {
315 continue;
316 }
317
318 const std::string abs_path = dir_path + base_name;
319 android::base::unique_fd fd(
320 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
321 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700322 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100323 break;
324 }
325
326 struct stat st = {};
327 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700328 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100329 continue;
330 }
331
Narayan Kamath3f31b632018-02-22 19:42:36 +0000332 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100333 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100334 continue;
335 }
336
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700337 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700338 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100339
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700340 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100341}
342
Narayan Kamathbd863722017-06-01 18:50:12 +0100343static bool AddDumps(const std::vector<DumpData>::const_iterator start,
344 const std::vector<DumpData>::const_iterator end,
345 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100346 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100347 for (auto it = start; it != end; ++it) {
348 const std::string& name = it->name;
349 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100350 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100351
352 // Seek to the beginning of the file before dumping any data. A given
353 // DumpData entry might be dumped multiple times in the report.
354 //
355 // For example, the most recent ANR entry is dumped to the body of the
356 // main entry and it also shows up as a separate entry in the bugreport
357 // ZIP file.
358 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
359 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
360 strerror(errno));
361 }
362
Narayan Kamath8f788292017-05-25 13:20:39 +0100363 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800364 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100365 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100366 }
367 } else {
368 dump_file_from_fd(type_name, name.c_str(), fd);
369 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100370 }
371
372 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700373}
374
Felipe Leme635ca312016-01-05 14:23:02 -0800375// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700376void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800377 char path[PATH_MAX];
378
379 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
380 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700381 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800382 char linkname[PATH_MAX];
383 ssize_t r = readlink(path, linkname, PATH_MAX);
384 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800385 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800386 return;
387 }
388 linkname[r] = '\0';
389
390 if (mount_points.find(linkname) == mount_points.end()) {
391 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700392 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700393 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800394 mount_points.insert(linkname);
395 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800396 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800397 }
398 }
399}
400
401void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700402 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700403 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800404 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800405 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700406 for_each_pid(do_mountinfo, nullptr);
407 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800408}
409
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700410static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
411{
412 DIR *d;
413 struct dirent *de;
414 char path[PATH_MAX];
415
416 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700417 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700418 return;
419 }
420
421 while ((de = readdir(d))) {
422 if (de->d_type != DT_LNK) {
423 continue;
424 }
425 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700426 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700427 }
428
429 closedir(d);
430}
431
Mark Salyzyn326842f2015-04-30 09:49:41 -0700432static bool skip_not_stat(const char *path) {
433 static const char stat[] = "/stat";
434 size_t len = strlen(path);
435 if (path[len - 1] == '/') { /* Directory? */
436 return false;
437 }
438 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
439}
440
Felipe Leme4c2d6632016-09-28 14:32:00 -0700441static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800442 return false;
443}
444
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700445unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700446
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800447//
448// stat offsets
449// Name units description
450// ---- ----- -----------
451// read I/Os requests number of read I/Os processed
452#define __STAT_READ_IOS 0
453// read merges requests number of read I/Os merged with in-queue I/O
454#define __STAT_READ_MERGES 1
455// read sectors sectors number of sectors read
456#define __STAT_READ_SECTORS 2
457// read ticks milliseconds total wait time for read requests
458#define __STAT_READ_TICKS 3
459// write I/Os requests number of write I/Os processed
460#define __STAT_WRITE_IOS 4
461// write merges requests number of write I/Os merged with in-queue I/O
462#define __STAT_WRITE_MERGES 5
463// write sectors sectors number of sectors written
464#define __STAT_WRITE_SECTORS 6
465// write ticks milliseconds total wait time for write requests
466#define __STAT_WRITE_TICKS 7
467// in_flight requests number of I/Os currently in flight
468#define __STAT_IN_FLIGHT 8
469// io_ticks milliseconds total time this block device has been active
470#define __STAT_IO_TICKS 9
471// time_in_queue milliseconds total wait time for all requests
472#define __STAT_IN_QUEUE 10
473#define __STAT_NUMBER_FIELD 11
474//
475// read I/Os, write I/Os
476// =====================
477//
478// These values increment when an I/O request completes.
479//
480// read merges, write merges
481// =========================
482//
483// These values increment when an I/O request is merged with an
484// already-queued I/O request.
485//
486// read sectors, write sectors
487// ===========================
488//
489// These values count the number of sectors read from or written to this
490// block device. The "sectors" in question are the standard UNIX 512-byte
491// sectors, not any device- or filesystem-specific block size. The
492// counters are incremented when the I/O completes.
493#define SECTOR_SIZE 512
494//
495// read ticks, write ticks
496// =======================
497//
498// These values count the number of milliseconds that I/O requests have
499// waited on this block device. If there are multiple I/O requests waiting,
500// these values will increase at a rate greater than 1000/second; for
501// example, if 60 read requests wait for an average of 30 ms, the read_ticks
502// field will increase by 60*30 = 1800.
503//
504// in_flight
505// =========
506//
507// This value counts the number of I/O requests that have been issued to
508// the device driver but have not yet completed. It does not include I/O
509// requests that are in the queue but not yet issued to the device driver.
510//
511// io_ticks
512// ========
513//
514// This value counts the number of milliseconds during which the device has
515// had I/O requests queued.
516//
517// time_in_queue
518// =============
519//
520// This value counts the number of milliseconds that I/O requests have waited
521// on this block device. If there are multiple I/O requests waiting, this
522// value will increase as the product of the number of milliseconds times the
523// number of requests waiting (see "read ticks" above for an example).
524#define S_TO_MS 1000
525//
526
Mark Salyzyn326842f2015-04-30 09:49:41 -0700527static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800528 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700529 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700530 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700531 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700532 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700533 getline(&buffer, &i, fp);
534 fclose(fp);
535 if (!buffer) {
536 return -errno;
537 }
538 i = strlen(buffer);
539 while ((i > 0) && (buffer[i - 1] == '\n')) {
540 buffer[--i] = '\0';
541 }
542 if (!*buffer) {
543 free(buffer);
544 return 0;
545 }
546 z = true;
547 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800548 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700549 if (fields[i] != 0) {
550 z = false;
551 }
552 }
553 if (z) { /* never accessed */
554 free(buffer);
555 return 0;
556 }
557
Wei Wang509bb5d2017-06-09 14:42:12 -0700558 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
559 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700560 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700561
562 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
563 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
564 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700565 free(buffer);
566
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800567 if (fields[__STAT_IO_TICKS]) {
568 unsigned long read_perf = 0;
569 unsigned long read_ios = 0;
570 if (fields[__STAT_READ_TICKS]) {
571 unsigned long long divisor = fields[__STAT_READ_TICKS]
572 * fields[__STAT_IO_TICKS];
573 read_perf = ((unsigned long long)SECTOR_SIZE
574 * fields[__STAT_READ_SECTORS]
575 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
576 / divisor;
577 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
578 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
579 / divisor;
580 }
581
582 unsigned long write_perf = 0;
583 unsigned long write_ios = 0;
584 if (fields[__STAT_WRITE_TICKS]) {
585 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
586 * fields[__STAT_IO_TICKS];
587 write_perf = ((unsigned long long)SECTOR_SIZE
588 * fields[__STAT_WRITE_SECTORS]
589 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
590 / divisor;
591 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
592 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
593 / divisor;
594 }
595
596 unsigned queue = (fields[__STAT_IN_QUEUE]
597 + (fields[__STAT_IO_TICKS] >> 1))
598 / fields[__STAT_IO_TICKS];
599
600 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700601 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 -0800602 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700603 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 -0800604 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800605 }
606
607 /* bugreport timeout factor adjustment */
608 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
609 worst_write_perf = write_perf;
610 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700611 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700612 return 0;
613}
614
Yao Chenbe3bbc12018-01-17 16:31:10 -0800615static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
616
617/* timeout in ms to read a list of buffers */
618static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
619 unsigned long timeout_ms = 0;
620 for (const auto& buffer : buffers) {
621 log_id_t id = android_name_to_log_id(buffer.c_str());
622 unsigned long property_size = __android_logger_get_buffer_size(id);
623 /* Engineering margin is ten-fold our guess */
624 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
625 }
626 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700627}
628
Nandana Duttd2f5f082019-01-18 17:13:52 +0000629Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
630}
631
632android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
633 std::lock_guard<std::mutex> lock(lock_);
634 result_ = APPROVED;
635 MYLOGD("User approved consent to share bugreport\n");
636 return android::binder::Status::ok();
637}
638
639android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
640 std::lock_guard<std::mutex> lock(lock_);
641 result_ = DENIED;
642 MYLOGW("User denied consent to share bugreport\n");
643 return android::binder::Status::ok();
644}
645
646UserConsentResult Dumpstate::ConsentCallback::getResult() {
647 std::lock_guard<std::mutex> lock(lock_);
648 return result_;
649}
650
651uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
652 return Nanotime() - start_time_;
653}
654
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700655void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700656 std::string build, fingerprint, radio, bootloader, network;
657 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700658
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700659 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
660 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700661 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
662 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
663 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700664 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700665
Felipe Lemed8b94e52016-12-08 10:21:44 -0800666 printf("========================================================\n");
667 printf("== dumpstate: %s\n", date);
668 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700669
Felipe Lemed8b94e52016-12-08 10:21:44 -0800670 printf("\n");
671 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700672 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800673 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
674 printf("Bootloader: %s\n", bootloader.c_str());
675 printf("Radio: %s\n", radio.c_str());
676 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100677 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
678 if (module_metadata_version != 0) {
679 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
680 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700681
Felipe Lemed8b94e52016-12-08 10:21:44 -0800682 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800683 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800684 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800685 printf("Uptime: ");
686 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
687 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800688 printf("Bugreport format version: %s\n", version_.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +0100689 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s bugreport_mode=%s\n", id_, pid_,
690 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800691 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800692}
693
Felipe Leme24b66ee2016-06-16 10:55:26 -0700694// List of file extensions that can cause a zip file attachment to be rejected by some email
695// service providers.
696static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
697 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
698 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
699 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
700};
701
Vishnu Naire97d6122018-01-18 13:58:56 -0800702status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
703 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700704 if (!IsZipping()) {
705 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
706 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800707 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800708 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700709 std::string valid_name = entry_name;
710
711 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700712 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700713 if (idx != std::string::npos) {
714 std::string extension = entry_name.substr(idx);
715 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
716 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
717 valid_name = entry_name + ".renamed";
718 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
719 }
720 }
721
Felipe Leme6fe9db62016-02-12 09:04:16 -0800722 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
723 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700724 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
725 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700726 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700727 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700728 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800729 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800730 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000731 bool finished_entry = false;
732 auto finish_entry = [this, &finished_entry] {
733 if (!finished_entry) {
734 // This should only be called when we're going to return an earlier error,
735 // which would've been logged. This may imply the file is already corrupt
736 // and any further logging from FinishEntry is more likely to mislead than
737 // not.
738 this->zip_writer_->FinishEntry();
739 }
740 };
741 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800742 auto start = std::chrono::steady_clock::now();
743 auto end = start + timeout;
744 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800745
Felipe Leme770410d2016-01-26 17:07:14 -0800746 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800747 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800748 if (timeout.count() > 0) {
749 // lambda to recalculate the timeout.
750 auto time_left_ms = [end]() {
751 auto now = std::chrono::steady_clock::now();
752 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
753 return std::max(diff.count(), 0LL);
754 };
755
756 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
757 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000758 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
759 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800760 return -errno;
761 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000762 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800763 entry_name.c_str(), strerror(errno), timeout.count());
764 return TIMED_OUT;
765 }
766 }
767
Zach Riggle22200402016-08-18 01:01:24 -0400768 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800769 if (bytes_read == 0) {
770 break;
771 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800772 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800773 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800774 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700775 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800776 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700777 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800778 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800779 }
780 }
781
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700782 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000783 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700784 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700785 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800786 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800787 }
788
Vishnu Naire97d6122018-01-18 13:58:56 -0800789 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800790}
791
Felipe Leme1d486fe2016-10-14 18:06:47 -0700792bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
793 android::base::unique_fd fd(
794 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700795 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800796 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800797 return false;
798 }
799
Vishnu Naire97d6122018-01-18 13:58:56 -0800800 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800801}
802
803/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700804static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800805 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800806}
807
Felipe Leme1d486fe2016-10-14 18:06:47 -0700808void Dumpstate::AddDir(const std::string& dir, bool recursive) {
809 if (!IsZipping()) {
810 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800811 return;
812 }
Felipe Leme678727a2016-09-21 17:22:11 -0700813 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800814 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700815 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800816}
817
Felipe Leme1d486fe2016-10-14 18:06:47 -0700818bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
819 if (!IsZipping()) {
820 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
821 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800822 return false;
823 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800824 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700825 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700826 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700827 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700828 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800829 return false;
830 }
831
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700832 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700833 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700834 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700835 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800836 return false;
837 }
838
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700839 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700840 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700841 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800842 return false;
843 }
844
845 return true;
846}
847
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800848static void DoKmsg() {
849 struct stat st;
850 if (!stat(PSTORE_LAST_KMSG, &st)) {
851 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
852 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
853 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
854 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
855 } else {
856 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
857 DumpFile("LAST KMSG", "/proc/last_kmsg");
858 }
859}
860
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800861static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800862 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800863 RunCommand(
864 "KERNEL LOG",
865 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
866 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
867}
868
Nandana Duttdb379fa2019-10-09 16:54:41 +0100869static void DoSystemLogcat(time_t since) {
870 char since_str[80];
871 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
872
873 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
874 RunCommand("SYSTEM LOG",
875 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
876 since_str},
877 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
878}
879
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800880static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800881 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800882 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
883 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800884 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100885 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800886 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
887 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800888 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800889 RunCommand(
890 "EVENT LOG",
891 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100892 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800893 timeout_ms = logcat_timeout({"stats"});
894 RunCommand(
895 "STATS LOG",
896 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100897 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800898 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800899 RunCommand(
900 "RADIO LOG",
901 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100902 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800903
904 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
905
906 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800907 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
908 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800909}
910
Mike Ma5c267872019-08-21 11:31:34 -0700911static void DumpIncidentReport() {
912 if (!ds.IsZipping()) {
913 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
914 return;
915 }
916 DurationReporter duration_reporter("INCIDENT REPORT");
917 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
918 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
919 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
920 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
921 if (fd < 0) {
922 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
923 return;
924 }
925 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
926 bool empty = 0 == lseek(fd, 0, SEEK_END);
927 if (!empty) {
928 // Use a different name from "incident.proto"
929 // /proto/incident.proto is reserved for incident service dump
930 // i.e. metadata for debugging.
931 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
932 }
933 unlink(path.c_str());
934}
935
Sunny Goyal35949782019-11-19 15:54:36 -0800936static void DumpVisibleWindowViews() {
937 if (!ds.IsZipping()) {
938 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
939 return;
940 }
941 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
942 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
943 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
944 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
945 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
946 if (fd < 0) {
947 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
948 return;
949 }
950 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
951 CommandOptions::WithTimeout(120).Build());
952 bool empty = 0 == lseek(fd, 0, SEEK_END);
953 if (!empty) {
954 ds.AddZipEntry("visible_windows.zip", path);
955 } else {
956 MYLOGW("Failed to dump visible windows\n");
957 }
958 unlink(path.c_str());
959}
960
Jayachandran Ca94c7172017-06-10 15:08:12 -0700961static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700962 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
963 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900964 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700965 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900966 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
967 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
968 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
969 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700970}
971
David Andersond9ba4752018-12-11 18:26:59 -0800972static void DumpDynamicPartitionInfo() {
973 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
974 return;
975 }
976
977 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -0700978 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -0800979}
980
Narayan Kamath8f788292017-05-25 13:20:39 +0100981static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
982 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
983 anr_traces_dir.c_str());
984
985 // If we're here, dump_traces_path will always be a temporary file
986 // (created with mkostemp or similar) that contains dumps taken earlier
987 // on in the process.
988 if (dump_traces_path != nullptr) {
989 if (add_to_zip) {
990 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
991 } else {
992 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
993 dump_traces_path);
994 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
995 }
996
997 const int ret = unlink(dump_traces_path);
998 if (ret == -1) {
999 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1000 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001001 }
1002 }
1003
Narayan Kamathbd863722017-06-01 18:50:12 +01001004 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001005 if (ds.anr_data_.size() > 0) {
1006 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001007 "VM TRACES AT LAST ANR", add_to_zip);
1008
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001009 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1010 // it will be present in the body of the main entry if |add_to_zip| == false.
1011 //
1012 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001013 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001014 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001015 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001016 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1017 }
1018}
1019
1020static void AddAnrTraceFiles() {
1021 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1022
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001023 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001024
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001025 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001026
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001027 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1028
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001029 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001030 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001031 int i = 0;
1032 while (true) {
1033 const std::string slow_trace_path =
1034 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1035 if (stat(slow_trace_path.c_str(), &st)) {
1036 // No traces file at this index, done with the files.
1037 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001038 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001039 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1040 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001041 }
1042}
1043
Wei Wang509bb5d2017-06-09 14:42:12 -07001044static void DumpBlockStatFiles() {
1045 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001046
Wei Wang1dc1ef52017-06-12 11:28:37 -07001047 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1048
1049 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001050 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1051 return;
1052 }
1053
1054 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001055 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001056 if ((d->d_name[0] == '.')
1057 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1058 || (d->d_name[1] == '\0'))) {
1059 continue;
1060 }
1061 const std::string new_path =
1062 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1063 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1064 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1065 printf("\n");
1066 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001067 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001068}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001069
1070static void DumpPacketStats() {
1071 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1072 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1073 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1074 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1075 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1076}
1077
1078static void DumpIpAddrAndRules() {
1079 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1080 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1081 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1082 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1083 RunCommand("IP RULES", {"ip", "rule", "show"});
1084 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1085}
1086
Nandana Dutt5c390032019-03-12 10:52:56 +00001087static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1088 std::chrono::milliseconds timeout,
1089 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001090 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001091 sp<android::IServiceManager> sm = defaultServiceManager();
1092 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001093 Vector<String16> args;
1094 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001095 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1096 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001097 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001098 std::string path(title);
1099 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001100 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001101 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001102 if (status == OK) {
1103 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1104 std::chrono::duration<double> elapsed_seconds;
1105 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1106 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001107 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1108 bool dump_complete = (status == OK);
1109 dumpsys.stopDumpThread(dump_complete);
1110 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001111
1112 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1113 std::chrono::steady_clock::now() - start);
1114 if (elapsed_duration > timeout) {
1115 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1116 elapsed_duration.count());
1117 break;
1118 }
1119 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001120 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001121}
1122
Vishnu Nair64afc022018-02-01 15:29:34 -08001123static void RunDumpsysText(const std::string& title, int priority,
1124 std::chrono::milliseconds timeout,
1125 std::chrono::milliseconds service_timeout) {
1126 DurationReporter duration_reporter(title);
1127 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1128 fsync(STDOUT_FILENO);
1129 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1130}
1131
1132/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001133static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1134 std::chrono::milliseconds timeout,
1135 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001136 DurationReporter duration_reporter(title);
1137 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1138 fsync(STDOUT_FILENO);
1139 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1140 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001141
1142 RETURN_IF_USER_DENIED_CONSENT();
1143
1144 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1145 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001146}
1147
Nandana Dutt5c390032019-03-12 10:52:56 +00001148static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1149 std::chrono::milliseconds timeout,
1150 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001151 if (!ds.IsZipping()) {
1152 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001153 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001154 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001155 sp<android::IServiceManager> sm = defaultServiceManager();
1156 Dumpsys dumpsys(sm.get());
1157 Vector<String16> args;
1158 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1159 DurationReporter duration_reporter(title);
1160
1161 auto start = std::chrono::steady_clock::now();
1162 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1163 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001164 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001165 std::string path(kProtoPath);
1166 path.append(String8(service).c_str());
1167 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1168 path.append("_CRITICAL");
1169 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1170 path.append("_HIGH");
1171 }
1172 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001173 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001174 if (status == OK) {
1175 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1176 bool dumpTerminated = (status == OK);
1177 dumpsys.stopDumpThread(dumpTerminated);
1178 }
1179 ZipWriter::FileEntry file_entry;
1180 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001181
1182 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1183 std::chrono::steady_clock::now() - start);
1184 if (elapsed_duration > timeout) {
1185 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1186 elapsed_duration.count());
1187 break;
1188 }
1189 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001190 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001191}
1192
Nandana Dutta7db6342018-11-21 14:53:34 +00001193// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001194static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001195 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1196 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001197
1198 RETURN_IF_USER_DENIED_CONSENT();
1199
1200 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1201 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001202}
1203
1204// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001205static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001206 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1207 // high priority. Reduce timeout once they are able to dump in a shorter time or
1208 // moved to a parallel task.
1209 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1210 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001211
1212 RETURN_IF_USER_DENIED_CONSENT();
1213
1214 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1215 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001216}
1217
1218// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001219static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001220 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001221
1222 RETURN_IF_USER_DENIED_CONSENT();
1223
1224 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1225 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001226}
1227
Steven Moreland44cd9482018-01-04 16:24:13 -08001228static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001229 if (!ds.IsZipping()) {
1230 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1231 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1232 return;
1233 }
1234 DurationReporter duration_reporter("DUMP HALS");
1235 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001236 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001237
Steven Moreland44cd9482018-01-04 16:24:13 -08001238 using android::hidl::manager::V1_0::IServiceManager;
1239 using android::hardware::defaultServiceManager;
1240
1241 sp<IServiceManager> sm = defaultServiceManager();
1242 if (sm == nullptr) {
1243 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1244 return;
1245 }
1246
1247 auto ret = sm->list([&](const auto& interfaces) {
1248 for (const std::string& interface : interfaces) {
1249 std::string cleanName = interface;
1250 std::replace_if(cleanName.begin(),
1251 cleanName.end(),
1252 [](char c) {
1253 return !isalnum(c) &&
1254 std::string("@-_:.").find(c) == std::string::npos;
1255 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001256 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001257
1258 {
1259 auto fd = android::base::unique_fd(
1260 TEMP_FAILURE_RETRY(open(path.c_str(),
1261 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1262 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1263 if (fd < 0) {
1264 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1265 continue;
1266 }
1267 RunCommandToFd(fd,
1268 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001269 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001270 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1271
1272 bool empty = 0 == lseek(fd, 0, SEEK_END);
1273 if (!empty) {
1274 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1275 }
1276 }
1277
1278 unlink(path.c_str());
1279 }
1280 });
1281
1282 if (!ret.isOk()) {
1283 MYLOGE("Could not list hals from hwservicemanager.\n");
1284 }
1285}
1286
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001287static void DumpExternalFragmentationInfo() {
1288 struct stat st;
1289 if (stat("/proc/buddyinfo", &st) != 0) {
1290 MYLOGE("Unable to dump external fragmentation info\n");
1291 return;
1292 }
1293
1294 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1295 std::ifstream ifs("/proc/buddyinfo");
1296 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1297 for (std::string line; std::getline(ifs, line);) {
1298 std::smatch match_results;
1299 if (std::regex_match(line, match_results, unusable_index_regex)) {
1300 std::stringstream free_pages(std::string{match_results[3]});
1301 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1302 std::istream_iterator<int>());
1303
1304 int total_free_pages = 0;
1305 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1306 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1307 }
1308
1309 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1310 match_results[2].str().c_str());
1311
1312 int usable_free_pages = total_free_pages;
1313 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1314 auto unusable_index = (total_free_pages - usable_free_pages) /
1315 static_cast<double>(total_free_pages);
1316 printf(" %5.3f", unusable_index);
1317 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1318 }
1319
1320 printf("\n");
1321 }
1322 }
1323 printf("\n");
1324}
1325
Nandana Dutt5c390032019-03-12 10:52:56 +00001326// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1327// via the consent they are shown. Ignores other errors that occur while running various
1328// commands. The consent checking is currently done around long running tasks, which happen to
1329// be distributed fairly evenly throughout the function.
1330static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001331 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001332
Nandana Dutt5c390032019-03-12 10:52:56 +00001333 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1334 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1335 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001336 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001337 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001338 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001339 DumpFile("MEMORY INFO", "/proc/meminfo");
1340 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001341 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001342
1343 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1344
Sunny Goyal35949782019-11-19 15:54:36 -08001345 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1346
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001347 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1348 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1349 DumpFile("SLAB INFO", "/proc/slabinfo");
1350 DumpFile("ZONEINFO", "/proc/zoneinfo");
1351 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1352 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001353 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001354
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001355 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1356 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001357
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001358 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001359 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001360
1361 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1362 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001363
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001364 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001365
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001366 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001367 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001368 struct stat s;
1369 if (stat("/proc/modules", &s) != 0) {
1370 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1371 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001372 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001373 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001374
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001375 if (__android_logger_property_get_bool(
1376 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1377 DoKernelLogcat();
1378 } else {
1379 do_dmesg();
1380 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001381
Felipe Lemef0292972016-11-22 13:57:05 -08001382 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001383
1384 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1385
Jeff Brown1dc94e32014-09-11 14:15:27 -07001386 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001387 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001388
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001389 /* Dump Bluetooth HCI logs */
1390 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001391
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001392 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001393 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001394 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001395 }
1396
Felipe Lemee184f662016-10-27 10:04:47 -07001397 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001398
Narayan Kamath8f788292017-05-25 13:20:39 +01001399 // NOTE: tombstones are always added as separate entries in the zip archive
1400 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001401 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001402 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001403 if (!tombstones_dumped) {
1404 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001405 }
1406
Jayachandran Ca94c7172017-06-10 15:08:12 -07001407 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001408
Chenbo Feng276a3b62018-08-07 11:44:49 -07001409 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1410
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001411 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001412
Jayachandran Ca94c7172017-06-10 15:08:12 -07001413 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001414
1415 dump_route_tables();
1416
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001417 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1418 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1419 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001420
Nandana Dutt5c390032019-03-12 10:52:56 +00001421 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001422
Elliott Hughes23ccc622017-02-28 10:14:22 -08001423 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001424
Jin Qianf334d662017-10-10 14:41:37 -07001425 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001426
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001427 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001428
Colin Crossf45fa6b2012-03-26 12:38:26 -07001429 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001430 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1431 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1432 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1433 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1434 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001435
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001436 /* Add window and surface trace files. */
1437 if (!PropertiesHelper::IsUserBuild()) {
1438 ds.AddDir(WMTRACE_DATA_DIR, false);
1439 }
1440
Nandana Dutt5c390032019-03-12 10:52:56 +00001441 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001442
Steven Moreland7440ddb2016-12-15 16:13:39 -08001443 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001444 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1445 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001446 // su does not exist on user builds, so try running without it.
1447 // This way any implementations of vril-dump that do not require
1448 // root can run on user builds.
1449 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001450 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001451 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001452 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001453 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001454 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001455 }
1456
Felipe Lemed8b94e52016-12-08 10:21:44 -08001457 printf("========================================================\n");
1458 printf("== Android Framework Services\n");
1459 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001460
Nandana Dutt5c390032019-03-12 10:52:56 +00001461 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001462
Felipe Lemed8b94e52016-12-08 10:21:44 -08001463 printf("========================================================\n");
1464 printf("== Checkins\n");
1465 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001466
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001467 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001468
1469 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1470
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001471 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1472 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1473 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1474 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001475
Felipe Lemed8b94e52016-12-08 10:21:44 -08001476 printf("========================================================\n");
1477 printf("== Running Application Activities\n");
1478 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001479
Makoto Onuki60780982018-04-16 15:34:00 -07001480 // The following dumpsys internally collects output from running apps, so it can take a long
1481 // time. So let's extend the timeout.
1482
1483 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1484
1485 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001486
Felipe Lemed8b94e52016-12-08 10:21:44 -08001487 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001488 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001489 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001490
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001491 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001492 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001493
Felipe Lemed8b94e52016-12-08 10:21:44 -08001494 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001495 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001496 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001497
Makoto Onuki60780982018-04-16 15:34:00 -07001498 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1499 DUMPSYS_COMPONENTS_OPTIONS);
1500
1501 printf("========================================================\n");
1502 printf("== Running Application Providers (platform)\n");
1503 printf("========================================================\n");
1504
1505 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1506 DUMPSYS_COMPONENTS_OPTIONS);
1507
1508 printf("========================================================\n");
1509 printf("== Running Application Providers (non-platform)\n");
1510 printf("========================================================\n");
1511
1512 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1513 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001514
Adrian Roos8b397ab2017-04-04 16:35:44 -07001515 printf("========================================================\n");
1516 printf("== Dropbox crashes\n");
1517 printf("========================================================\n");
1518
1519 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1520 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1521
Felipe Lemed8b94e52016-12-08 10:21:44 -08001522 printf("========================================================\n");
1523 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1524 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1525 printf("========================================================\n");
1526 printf("== dumpstate: done (id %d)\n", ds.id_);
1527 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001528
1529 printf("========================================================\n");
1530 printf("== Obtaining statsd metadata\n");
1531 printf("========================================================\n");
1532 // This differs from the usual dumpsys stats, which is the stats report data.
1533 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001534
1535 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1536
Nandana Dutt5c390032019-03-12 10:52:56 +00001537 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001538}
1539
Nandana Dutt5c390032019-03-12 10:52:56 +00001540/*
1541 * Dumps state for the default case; drops root after it's no longer necessary.
1542 *
1543 * Returns RunStatus::OK if everything went fine.
1544 * Returns RunStatus::ERROR if there was an error.
1545 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1546 * with the caller.
1547 */
1548static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001549 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001550 // keep the system stats as close to its initial state as possible.
Nandana Dutt5c390032019-03-12 10:52:56 +00001551 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001552
Nandana Duttdb379fa2019-10-09 16:54:41 +01001553 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1554 // buffer.
1555 DoLogcat();
1556 // Capture timestamp after first logcat to use in next logcat
1557 time_t logcat_ts = time(nullptr);
1558
Nandana Dutt4be45d12018-09-26 15:04:23 +01001559 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001560 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001561
1562 /* Run some operations that require root. */
1563 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1564 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1565
1566 ds.AddDir(RECOVERY_DIR, true);
1567 ds.AddDir(RECOVERY_DATA_DIR, true);
1568 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1569 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1570 if (!PropertiesHelper::IsUserBuild()) {
1571 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1572 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1573 }
1574 add_mountinfo();
1575 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001576 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001577 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001578
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001579 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001580 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1581
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001582 // Dump IPsec stats. No keys are exposed here.
1583 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1584
Nandana Dutt4be45d12018-09-26 15:04:23 +01001585 // Run ss as root so we can see socket marks.
1586 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1587
1588 // Run iotop as root to show top 100 IO threads
1589 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1590
Erick Reyese68df822019-02-11 14:46:36 -08001591 // Gather shared memory buffer info if the product implements it
1592 struct stat st;
1593 if (!stat("/product/bin/dmabuf_dump", &st)) {
1594 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1595 }
1596
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001597 DumpFile("PSI cpu", "/proc/pressure/cpu");
1598 DumpFile("PSI memory", "/proc/pressure/memory");
1599 DumpFile("PSI io", "/proc/pressure/io");
1600
Nandana Dutt4be45d12018-09-26 15:04:23 +01001601 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001602 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001603 }
1604
Nandana Dutt5c390032019-03-12 10:52:56 +00001605 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001606 Dumpstate::RunStatus status = dumpstate();
1607 // Capture logcat since the last time we did it.
1608 DoSystemLogcat(logcat_ts);
1609 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001610}
1611
mukesh agrawal253dad42018-01-23 21:59:59 -08001612// This method collects common dumpsys for telephony and wifi
1613static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001614 DumpIpTablesAsRoot();
1615
Jayachandran Cb4389d92019-07-08 09:46:05 -07001616 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1617
Jayachandran Ca94c7172017-06-10 15:08:12 -07001618 if (!DropRootUser()) {
1619 return;
1620 }
1621
1622 do_dmesg();
1623 DoLogcat();
1624 DumpPacketStats();
1625 DoKmsg();
1626 DumpIpAddrAndRules();
1627 dump_route_tables();
Jayachandran Cb4389d92019-07-08 09:46:05 -07001628 DumpHals();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001629
1630 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1631 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001632}
1633
1634// This method collects dumpsys for telephony debugging only
1635static void DumpstateTelephonyOnly() {
1636 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001637 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001638
1639 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001640
1641 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1642
1643 printf("========================================================\n");
1644 printf("== Android Framework Services\n");
1645 printf("========================================================\n");
1646
Vishnu Nair652cc802017-11-30 15:18:30 -08001647 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1648 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001649 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1650 SEC_TO_MSEC(10));
1651 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001652 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1653 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001654 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1655 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001656 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1657 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001658
1659 printf("========================================================\n");
1660 printf("== Running Application Services\n");
1661 printf("========================================================\n");
1662
1663 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1664
1665 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001666 printf("== Running Application Services (non-platform)\n");
1667 printf("========================================================\n");
1668
1669 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1670 DUMPSYS_COMPONENTS_OPTIONS);
1671
1672 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001673 printf("== Checkins\n");
1674 printf("========================================================\n");
1675
1676 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1677
1678 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001679 printf("== dumpstate: done (id %d)\n", ds.id_);
1680 printf("========================================================\n");
1681}
1682
mukesh agrawal253dad42018-01-23 21:59:59 -08001683// This method collects dumpsys for wifi debugging only
1684static void DumpstateWifiOnly() {
1685 DurationReporter duration_reporter("DUMPSTATE");
1686
1687 DumpstateRadioCommon();
1688
1689 printf("========================================================\n");
1690 printf("== Android Framework Services\n");
1691 printf("========================================================\n");
1692
1693 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1694 SEC_TO_MSEC(10));
1695 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1696 SEC_TO_MSEC(10));
1697
1698 printf("========================================================\n");
1699 printf("== dumpstate: done (id %d)\n", ds.id_);
1700 printf("========================================================\n");
1701}
1702
Nandana Duttcf419a72019-03-14 10:40:17 +00001703Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001704 DurationReporter duration_reporter("DUMP TRACES");
1705
1706 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1707 const size_t buf_size = temp_file_pattern.length() + 1;
1708 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1709 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1710
1711 // Create a new, empty file to receive all trace dumps.
1712 //
1713 // TODO: This can be simplified once we remove support for the old style
1714 // dumps. We can have a file descriptor passed in to dump_traces instead
1715 // of creating a file, closing it and then reopening it again.
1716 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1717 if (fd < 0) {
1718 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001719 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001720 }
1721
1722 // Nobody should have access to this temporary file except dumpstate, but we
1723 // temporarily grant 'read' to 'others' here because this file is created
1724 // when tombstoned is still running as root, but dumped after dropping. This
1725 // can go away once support for old style dumping has.
1726 const int chmod_ret = fchmod(fd, 0666);
1727 if (chmod_ret < 0) {
1728 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001729 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001730 }
1731
1732 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1733 if (proc.get() == nullptr) {
1734 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001735 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001736 }
1737
1738 // Number of times process dumping has timed out. If we encounter too many
1739 // failures, we'll give up.
1740 int timeout_failures = 0;
1741 bool dalvik_found = false;
1742
1743 const std::set<int> hal_pids = get_interesting_hal_pids();
1744
1745 struct dirent* d;
1746 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001747 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001748 int pid = atoi(d->d_name);
1749 if (pid <= 0) {
1750 continue;
1751 }
1752
1753 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1754 std::string exe;
1755 if (!android::base::Readlink(link_name, &exe)) {
1756 continue;
1757 }
1758
1759 bool is_java_process;
1760 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1761 // Don't bother dumping backtraces for the zygote.
1762 if (IsZygote(pid)) {
1763 continue;
1764 }
1765
1766 dalvik_found = true;
1767 is_java_process = true;
1768 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1769 is_java_process = false;
1770 } else {
1771 // Probably a native process we don't care about, continue.
1772 continue;
1773 }
1774
1775 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1776 if (timeout_failures == 3) {
1777 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1778 break;
1779 }
1780
1781 const uint64_t start = Nanotime();
1782 const int ret = dump_backtrace_to_file_timeout(
1783 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1784 is_java_process ? 5 : 20, fd);
1785
1786 if (ret == -1) {
1787 // For consistency, the header and footer to this message match those
1788 // dumped by debuggerd in the success case.
1789 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1790 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1791 dprintf(fd, "---- end %d ----", pid);
1792 timeout_failures++;
1793 continue;
1794 }
1795
1796 // We've successfully dumped stack traces, reset the failure count
1797 // and write a summary of the elapsed time to the file and continue with the
1798 // next process.
1799 timeout_failures = 0;
1800
1801 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1802 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1803 }
1804
1805 if (!dalvik_found) {
1806 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1807 }
1808
Nandana Duttcf419a72019-03-14 10:40:17 +00001809 *path = file_name_buf.release();
1810 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001811}
1812
Felipe Leme6f674ae2016-11-18 17:10:33 -08001813void Dumpstate::DumpstateBoard() {
1814 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001815 printf("========================================================\n");
1816 printf("== Board\n");
1817 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001818
Felipe Leme6f674ae2016-11-18 17:10:33 -08001819 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001820 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001821 return;
1822 }
1823
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001824 std::vector<std::string> paths;
1825 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001826 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001827 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1828 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001829 remover.emplace_back(android::base::make_scope_guard(
1830 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001831 }
Jie Song9fbfad02017-06-20 16:29:42 -07001832
Wei Wang587eac92018-04-05 12:17:20 -07001833 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1834 if (dumpstate_device == nullptr) {
1835 MYLOGE("No IDumpstateDevice implementation\n");
1836 return;
1837 }
1838
1839 using ScopedNativeHandle =
1840 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1841 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1842 [](native_handle_t* handle) {
1843 native_handle_close(handle);
1844 native_handle_delete(handle);
1845 });
1846 if (handle == nullptr) {
1847 MYLOGE("Could not create native_handle\n");
1848 return;
1849 }
1850
Nandana Dutt5c390032019-03-12 10:52:56 +00001851 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001852 for (size_t i = 0; i < paths.size(); i++) {
1853 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1854
1855 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1856 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1857 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1858 if (fd < 0) {
1859 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1860 return;
1861 }
1862 handle.get()->data[i] = fd.release();
1863 }
1864
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001865 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001866 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1867 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1868 // and grab whatever dumped
1869 std::packaged_task<bool()>
1870 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001871 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1872 if (!status.isOk()) {
1873 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001874 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001875 }
Wei Wang587eac92018-04-05 12:17:20 -07001876 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001877 });
Wei Wang587eac92018-04-05 12:17:20 -07001878
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001879 auto result = dumpstate_task.get_future();
1880 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001881
1882 constexpr size_t timeout_sec = 30;
1883 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1884 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1885 if (!android::base::SetProperty("ctl.interface_restart",
1886 android::base::StringPrintf("%s/default",
1887 IDumpstateDevice::descriptor))) {
1888 MYLOGE("Couldn't restart dumpstate HAL\n");
1889 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001890 }
Wei Wang587eac92018-04-05 12:17:20 -07001891 // Wait some time for init to kill dumpstate vendor HAL
1892 constexpr size_t killing_timeout_sec = 10;
1893 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1894 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1895 "there might be racing in content\n", killing_timeout_sec);
1896 }
1897
1898 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1899 for (size_t i = 0; i < paths.size(); i++) {
1900 struct stat s;
1901 if (fstat(handle.get()->data[i], &s) == -1) {
1902 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1903 strerror(errno));
1904 file_sizes[i] = -1;
1905 continue;
1906 }
1907 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001908 }
1909
1910 for (size_t i = 0; i < paths.size(); i++) {
1911 if (file_sizes[i] == -1) {
1912 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001913 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001914 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001915 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001916 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001917 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001918 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001919 }
1920
Felipe Lemed8b94e52016-12-08 10:21:44 -08001921 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001922}
1923
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001924static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001925 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001926 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Abhijeet Kaure370d682019-10-01 16:49:30 +01001927 "[-z]] [-s] [-S] [-q] [-P] [-R] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001928 " -h: display this help message\n"
1929 " -b: play sound file instead of vibrate, at beginning of job\n"
1930 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001931 " -d: append date to filename\n"
1932 " -p: capture screenshot to filename.png\n"
1933 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001934 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001935 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001936 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01001937 " -P: send broadcast when started and do progress updates\n"
1938 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001939 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001940 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001941}
1942
Wei Liuf87959e2016-08-26 14:51:42 -07001943static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001944 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001945}
1946
Felipe Leme1d486fe2016-10-14 18:06:47 -07001947bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001948 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001949 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001950 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001951 // Final timestamp
1952 char date[80];
1953 time_t the_real_now_please_stand_up = time(nullptr);
1954 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001955 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001956 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001957
Felipe Leme9a523ae2016-10-20 15:10:33 -07001958 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001959 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001960 return false;
1961 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001962 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001963 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001964 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001965 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001966
Felipe Leme0f3fb202016-06-10 17:10:53 -07001967 // Add log file (which contains stderr output) to zip...
1968 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001969 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001970 MYLOGE("Failed to add dumpstate log to .zip file\n");
1971 return false;
1972 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001973 // TODO: Should truncate the existing file.
1974 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001975 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1976 return false;
1977 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001978 fprintf(stderr, "\n");
1979
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001980 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001981 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001982 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001983 return false;
1984 }
1985
Felipe Leme1d486fe2016-10-14 18:06:47 -07001986 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1987 ds.zip_file.reset(nullptr);
1988
Felipe Lemee9d2c542016-11-15 11:48:26 -08001989 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001990 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001991
Felipe Leme1e9edc62015-12-21 16:02:13 -08001992 return true;
1993}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001994
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001995static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1996 // clang-format off
1997 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1998 "--receiver-foreground", "--receiver-include-background", "-a", action};
1999 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002000
2001 am.insert(am.end(), args.begin(), args.end());
2002
Felipe Leme8d2410e2017-02-08 09:46:08 -08002003 RunCommand("", am,
2004 CommandOptions::WithTimeout(20)
2005 .Log("Sending broadcast: '%s'\n")
2006 .Always()
2007 .DropRoot()
2008 .RedirectStderr()
2009 .Build());
2010}
2011
Felipe Leme35b8cf12017-02-10 15:47:29 -08002012static void Vibrate(int duration_ms) {
2013 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002014 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002015 CommandOptions::WithTimeout(10)
2016 .Log("Vibrate: '%s'\n")
2017 .Always()
2018 .Build());
2019 // clang-format on
2020}
2021
Nandana Dutt979388e2018-11-30 16:48:55 +00002022static void MaybeResolveSymlink(std::string* path) {
2023 std::string resolved_path;
2024 if (android::base::Readlink(*path, &resolved_path)) {
2025 *path = resolved_path;
2026 }
2027}
2028
Nandana Dutt4be45d12018-09-26 15:04:23 +01002029/*
2030 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2031 * if we are writing zip files and adds the version file.
2032 */
2033static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002034 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2035
Nandana Dutt4be45d12018-09-26 15:04:23 +01002036 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2037 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002038 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002039 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002040 char date[80];
2041 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2042 ds.name_ = date;
2043 } else {
2044 ds.name_ = "undated";
2045 }
2046
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002047 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002048 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002049 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002050 ds.base_name_ += "-wifi";
2051 }
2052
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002053 if (ds.options_->do_fb) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002054 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.png" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002055 }
2056 ds.tmp_path_ = ds.GetPath(".tmp");
2057 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2058
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002059 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002060 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002061 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002062 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002063 "Bugreport dir: [%s] "
2064 "Base name: [%s] "
2065 "Suffix: [%s] "
2066 "Log path: [%s] "
2067 "Temporary path: [%s] "
2068 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002069 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2070 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002071
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002072 if (ds.options_->do_zip_file) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002073 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.zip" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002074 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2075 create_parent_dirs(ds.path_.c_str());
2076 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2077 if (ds.zip_file == nullptr) {
2078 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2079 } else {
2080 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2081 }
2082 ds.AddTextZipEntry("version.txt", ds.version_);
2083 }
2084}
2085
2086/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002087 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002088 * printing zipped file status, etc.
2089 */
2090static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002091 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002092 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002093 if (!ds.FinishZipFile()) {
2094 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2095 do_text_file = true;
2096 } else {
2097 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002098 }
2099 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002100 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002101 if (do_text_file) {
2102 dprintf(ds.control_socket_fd_,
2103 "FAIL:could not create zip file, check %s "
2104 "for more details\n",
2105 ds.log_path_.c_str());
2106 } else {
2107 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2108 }
2109 }
2110}
2111
Nandana Dutt4be45d12018-09-26 15:04:23 +01002112
Nandana Dutt58d72e22018-11-16 10:30:48 +00002113static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2114 switch (mode) {
2115 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2116 return "BUGREPORT_FULL";
2117 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2118 return "BUGREPORT_INTERACTIVE";
2119 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2120 return "BUGREPORT_REMOTE";
2121 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2122 return "BUGREPORT_WEAR";
2123 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2124 return "BUGREPORT_TELEPHONY";
2125 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2126 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002127 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2128 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002129 }
2130}
2131
2132static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002133 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002134 switch (mode) {
2135 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Nandana Dutt58d72e22018-11-16 10:30:48 +00002136 options->do_fb = true;
2137 break;
2138 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002139 // Currently, the dumpstate binder is only used by Shell to update progress.
2140 options->do_start_service = true;
2141 options->do_progress_updates = true;
2142 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002143 break;
2144 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002145 options->do_vibrate = false;
2146 options->is_remote_mode = true;
2147 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002148 break;
2149 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002150 options->do_start_service = true;
2151 options->do_progress_updates = true;
2152 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002153 options->do_fb = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002154 break;
2155 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002156 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002157 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002158 break;
2159 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002160 options->wifi_only = true;
2161 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002162 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002163 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002164 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2165 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002166 }
2167}
2168
Nandana Dutt58d72e22018-11-16 10:30:48 +00002169static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002170 MYLOGI(
2171 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_fb: %d "
2172 "is_remote_mode: %d show_header_only: %d do_start_service: %d telephony_only: %d "
2173 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s args: %s\n",
2174 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
2175 options.do_fb, options.is_remote_mode, options.show_header_only, options.do_start_service,
2176 options.telephony_only, options.wifi_only, options.do_progress_updates,
2177 options.bugreport_fd.get(), options.bugreport_mode.c_str(), options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002178}
2179
Nandana Dutt54dbd672019-01-11 12:58:05 +00002180void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2181 const android::base::unique_fd& bugreport_fd_in,
2182 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002183 // In the new API world, date is always added; output is always a zip file.
2184 // TODO(111441001): remove these options once they are obsolete.
2185 do_add_date = true;
2186 do_zip_file = true;
2187
Nandana Dutt54dbd672019-01-11 12:58:05 +00002188 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2189 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2190 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002191
Nandana Dutt58d72e22018-11-16 10:30:48 +00002192 SetOptionsFromMode(bugreport_mode, this);
2193}
2194
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002195Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2196 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002197 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002198 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002199 switch (c) {
2200 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002201 case 'd': do_add_date = true; break;
2202 case 'z': do_zip_file = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002203 case 's': use_socket = true; break;
2204 case 'S': use_control_socket = true; break;
2205 case 'v': show_header_only = true; break;
2206 case 'q': do_vibrate = false; break;
2207 case 'p': do_fb = true; break;
2208 case 'P': do_progress_updates = true; break;
2209 case 'R': is_remote_mode = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002210 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002211 case 'w':
2212 // This was already processed
2213 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002214 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002215 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002216 break;
2217 default:
2218 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002219 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002220 break;
2221 // clang-format on
2222 }
2223 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002224
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002225 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002226 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002227 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002228 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002229 }
2230 }
2231
2232 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2233 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002234
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002235 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002236}
2237
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002238bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002239 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002240 return false;
2241 }
2242
Abhijeet Kaure370d682019-10-01 16:49:30 +01002243 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002244 return false;
2245 }
2246
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002247 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002248 return false;
2249 }
2250
Abhijeet Kaure370d682019-10-01 16:49:30 +01002251 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002252 return false;
2253 }
2254 return true;
2255}
2256
Nandana Dutt197661d2018-11-16 16:40:21 +00002257void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2258 options_ = std::move(options);
2259}
2260
Nandana Duttd2f5f082019-01-18 17:13:52 +00002261Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2262 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002263 if (listener_ != nullptr) {
2264 switch (status) {
2265 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002266 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002267 break;
2268 case Dumpstate::RunStatus::HELP:
2269 break;
2270 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002271 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002272 break;
2273 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002274 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2275 break;
2276 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2277 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2278 break;
2279 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2280 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002281 break;
2282 }
2283 }
2284 return status;
2285}
2286
Nandana Dutt979388e2018-11-30 16:48:55 +00002287/*
2288 * Dumps relevant information to a bugreport based on the given options.
2289 *
2290 * The bugreport can be dumped to a file or streamed to a socket.
2291 *
2292 * How dumping to file works:
2293 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2294 * stderr is redirected a log file.
2295 *
2296 * The temporary bugreport is then populated via printfs, dumping contents of files and
2297 * output of commands to stdout.
2298 *
2299 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2300 * text file.
2301 *
2302 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2303 * gets added to the archive.
2304 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002305 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2306 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002307 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002308Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2309 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002310 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002311 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002312 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002313 return RunStatus::INVALID_INPUT;
2314 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002315 /* set as high priority, and protect from OOM killer */
2316 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002317
Felipe Lemed071c682016-10-20 16:48:00 -07002318 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002319 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002320 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002321 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002322 } else {
2323 /* fallback to kernels <= 2.6.35 */
2324 oom_adj = fopen("/proc/self/oom_adj", "we");
2325 if (oom_adj) {
2326 fputs("-17", oom_adj);
2327 fclose(oom_adj);
2328 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002329 }
2330
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002331 if (version_ == VERSION_DEFAULT) {
2332 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002333 }
2334
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002335 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002336 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002337 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002338 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002339 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002340 }
2341
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002342 if (options_->show_header_only) {
2343 PrintHeader();
2344 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002345 }
2346
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002347 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2348 calling_uid, calling_package.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +01002349 if (CalledByApi()) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002350 // If the output needs to be copied over to the caller's fd, get user consent.
2351 android::String16 package(calling_package.c_str());
2352 CheckUserConsent(calling_uid, package);
2353 }
2354
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002355 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002356 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002357
2358 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002359 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002360 is_redirecting
2361 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2362 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002363 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002364
Felipe Lemed071c682016-10-20 16:48:00 -07002365 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002366 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002367 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002368 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2369
Sahana Raof35ed432019-07-12 10:47:52 +01002370 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2371 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2372 } else {
2373 // Wake lock will be released automatically on process death
2374 MYLOGD("Wake lock acquired.\n");
2375 }
2376
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002377 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002378
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002379 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002380 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002381 MYLOGI("Starting 'dumpstate' service\n");
2382 android::status_t ret;
2383 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2384 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2385 }
2386 }
2387
Felipe Lemef0292972016-11-22 13:57:05 -08002388 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002389 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2390 }
2391
Nandana Dutt235c6672019-11-14 15:22:32 +00002392 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2393 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002394
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002395 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002396
Christopher Ferrised9354f2014-10-01 17:35:01 -07002397 // If we are going to use a socket, do it as early as possible
2398 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002399 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002400 if (!redirect_to_socket(stdout, "dumpstate")) {
2401 return ERROR;
2402 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002403 }
2404
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002405 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002406 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002407 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002408 if (control_socket_fd_ == -1) {
2409 return ERROR;
2410 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002411 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002412 }
2413
Felipe Leme71bbfc52015-11-23 14:14:51 -08002414 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002415 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002416
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002417 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002418 // clang-format off
2419 std::vector<std::string> am_args = {
2420 "--receiver-permission", "android.permission.DUMP",
2421 };
2422 // clang-format on
2423 // Send STARTED broadcast for apps that listen to bugreport generation events
2424 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002425 if (options_->use_control_socket) {
2426 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002427 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002428 }
2429 }
2430
Nick Kralevichf3599b32016-01-25 15:05:16 -08002431 /* read /proc/cmdline before dropping root */
2432 FILE *cmdline = fopen("/proc/cmdline", "re");
2433 if (cmdline) {
2434 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2435 fclose(cmdline);
2436 }
2437
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002438 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002439 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002440 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002441
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002442 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002443 MYLOGI("taking early screenshot\n");
2444 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002445 }
2446
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002447 if (options_->do_zip_file && zip_file != nullptr) {
2448 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2449 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002450 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002451 }
2452 }
2453
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002454 int dup_stdout_fd;
2455 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002456 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002457 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002458 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002459 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2460 return ERROR;
2461 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002462 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2463 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2464 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002465 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002466
2467 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2468 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002469 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002470 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002471 /* TODO: rather than generating a text file now and zipping it later,
2472 it would be more efficient to redirect stdout to the zip entry
2473 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002474 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2475 return ERROR;
2476 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002477 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002478 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002479 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002480 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002481 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002482
2483 // Don't buffer stdout
2484 setvbuf(stdout, nullptr, _IONBF, 0);
2485
Felipe Leme608385d2016-02-01 10:35:38 -08002486 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2487 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002488 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002489 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002490
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002491 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002492 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002493 DumpstateBoard();
2494 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002495 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002496 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002497 // Dump state for the default case. This also drops root.
Nandana Dutt5c390032019-03-12 10:52:56 +00002498 RunStatus s = DumpstateDefault();
2499 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002500 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002501 HandleUserConsentDenied();
2502 }
2503 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002504 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002505 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002506
Felipe Leme55b42a62015-11-10 17:39:08 -08002507 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002508 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002509 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002510 }
2511
Abhijeet Kaure370d682019-10-01 16:49:30 +01002512 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002513 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002514 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002515 }
2516
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002517 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002518 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002519 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002520 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002521 if (status != Dumpstate::RunStatus::OK &&
2522 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2523 // Do an early return if there were errors. We make an exception for consent
2524 // timing out because it's possible the user got distracted. In this case the
2525 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002526 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002527 return status;
2528 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002529 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002530 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2531 options_->screenshot_fd.get());
2532 if (copy_succeeded) {
2533 android::os::UnlinkAndLogOnError(screenshot_path_);
2534 }
2535 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002536 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2537 MYLOGI(
2538 "Did not receive user consent yet."
2539 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002540 const String16 incidentcompanion("incidentcompanion");
2541 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2542 if (ics != nullptr) {
2543 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2544 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2545 consent_callback_.get());
2546 } else {
2547 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2548 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002549 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002550 }
2551
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002552 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002553 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002554 for (int i = 0; i < 3; i++) {
2555 Vibrate(75);
2556 usleep((75 + 50) * 1000);
2557 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002558 }
2559
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002560 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2561 progress_->GetInitialMax());
2562 progress_->Save();
2563 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002564
Felipe Leme107a05f2016-03-08 15:11:15 -08002565 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002566 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002567 }
2568
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002569 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002570 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002571 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002572 }
2573
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002574 tombstone_data_.clear();
2575 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002576
Nandana Duttd2f5f082019-01-18 17:13:52 +00002577 return (consent_callback_ != nullptr &&
2578 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2579 ? USER_CONSENT_TIMED_OUT
2580 : RunStatus::OK;
2581}
2582
2583void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002584 if (calling_uid == AID_SHELL) {
2585 return;
2586 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002587 consent_callback_ = new ConsentCallback();
2588 const String16 incidentcompanion("incidentcompanion");
2589 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2590 if (ics != nullptr) {
2591 MYLOGD("Checking user consent via incidentcompanion service\n");
2592 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Joe Onorato1c36d752019-03-17 18:26:43 -07002593 calling_uid, calling_package, String16(), String16(),
2594 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002595 } else {
2596 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2597 }
2598}
2599
Nandana Dutt5c390032019-03-12 10:52:56 +00002600bool Dumpstate::IsUserConsentDenied() const {
2601 return ds.consent_callback_ != nullptr &&
2602 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2603}
2604
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002605bool Dumpstate::CalledByApi() const {
2606 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2607}
2608
Nandana Duttd2f5f082019-01-18 17:13:52 +00002609void Dumpstate::CleanupFiles() {
2610 android::os::UnlinkAndLogOnError(tmp_path_);
2611 android::os::UnlinkAndLogOnError(screenshot_path_);
2612 android::os::UnlinkAndLogOnError(path_);
2613}
2614
2615Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2616 MYLOGD("User denied consent; deleting files and returning\n");
2617 CleanupFiles();
2618 return USER_CONSENT_DENIED;
2619}
2620
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002621Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002622 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002623 // user consent (unless the caller is Shell).
2624 UserConsentResult consent_result;
2625 if (calling_uid == AID_SHELL) {
2626 consent_result = UserConsentResult::APPROVED;
2627 } else {
2628 consent_result = consent_callback_->getResult();
2629 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002630 if (consent_result == UserConsentResult::UNAVAILABLE) {
2631 // User has not responded yet.
2632 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2633 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2634 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2635 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2636 sleep(delay_seconds);
2637 }
2638 consent_result = consent_callback_->getResult();
2639 }
2640 if (consent_result == UserConsentResult::DENIED) {
2641 // User has explicitly denied sharing with the app. To be safe delete the
2642 // internal bugreport & tmp files.
2643 return HandleUserConsentDenied();
2644 }
2645 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002646 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2647 if (copy_succeeded) {
2648 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002649 }
2650 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2651 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2652 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2653 // Since we do not have user consent to share the bugreport it does not get
2654 // copied over to the calling app but remains in the internal directory from
2655 // where the user can manually pull it.
2656 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2657 }
2658 // Unknown result; must be a programming error.
2659 MYLOGE("Unknown user consent result:%d\n", consent_result);
2660 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002661}
2662
Nandana Duttf02564e2019-02-15 15:24:24 +00002663Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002664 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2665 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2666 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002667 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002668 // When directly running dumpstate binary, the output is not expected to be written
2669 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002670 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002671
2672 // calling_uid and calling_package are for user consent to share the bugreport with
2673 // an app; they are irrelvant here because bugreport is only written to a local
2674 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002675 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002676 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002677 return status;
2678}
2679
2680/* Main entry point for dumpstate binary. */
2681int run_main(int argc, char* argv[]) {
2682 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002683
2684 switch (status) {
2685 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002686 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002687 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002688 ShowUsage();
2689 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002690 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002691 fprintf(stderr, "Invalid combination of args\n");
2692 ShowUsage();
2693 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002694 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002695 FALLTHROUGH_INTENDED;
2696 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2697 FALLTHROUGH_INTENDED;
2698 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002699 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002700 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002701}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002702
2703// TODO(111441001): Default DumpOptions to sensible values.
2704Dumpstate::Dumpstate(const std::string& version)
2705 : pid_(getpid()),
2706 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01002707 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002708 version_(version),
2709 now_(time(nullptr)) {
2710}
2711
2712Dumpstate& Dumpstate::GetInstance() {
2713 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2714 return singleton_;
2715}
2716
Nandana Dutt8d945c02019-08-14 13:30:07 +01002717DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2718 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002719 if (!title_.empty()) {
2720 started_ = Nanotime();
2721 }
2722}
2723
2724DurationReporter::~DurationReporter() {
2725 if (!title_.empty()) {
2726 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
Nandana Dutt8d945c02019-08-14 13:30:07 +01002727 if (elapsed < .5f && !verbose_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002728 return;
2729 }
2730 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
2731 if (logcat_only_) {
2732 return;
2733 }
2734 // Use "Yoda grammar" to make it easier to grep|sort sections.
2735 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
2736 }
2737}
2738
2739const int32_t Progress::kDefaultMax = 5000;
2740
2741Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2742}
2743
2744Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2745 : Progress(initial_max, growth_factor, "") {
2746 progress_ = progress;
2747}
2748
2749Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2750 : initial_max_(initial_max),
2751 progress_(0),
2752 max_(initial_max),
2753 growth_factor_(growth_factor),
2754 n_runs_(0),
2755 average_max_(0),
2756 path_(path) {
2757 if (!path_.empty()) {
2758 Load();
2759 }
2760}
2761
2762void Progress::Load() {
2763 MYLOGD("Loading stats from %s\n", path_.c_str());
2764 std::string content;
2765 if (!android::base::ReadFileToString(path_, &content)) {
2766 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2767 return;
2768 }
2769 if (content.empty()) {
2770 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2771 return;
2772 }
2773 std::vector<std::string> lines = android::base::Split(content, "\n");
2774
2775 if (lines.size() < 1) {
2776 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2777 (int)lines.size(), max_);
2778 return;
2779 }
2780 char* ptr;
2781 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2782 average_max_ = strtol(ptr, nullptr, 10);
2783 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2784 average_max_ > STATS_MAX_AVERAGE) {
2785 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2786 initial_max_ = Progress::kDefaultMax;
2787 } else {
2788 initial_max_ = average_max_;
2789 }
2790 max_ = initial_max_;
2791
2792 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2793}
2794
2795void Progress::Save() {
2796 int32_t total = n_runs_ * average_max_ + progress_;
2797 int32_t runs = n_runs_ + 1;
2798 int32_t average = floor(((float)total) / runs);
2799 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2800 path_.c_str());
2801 if (path_.empty()) {
2802 return;
2803 }
2804
2805 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2806 if (!android::base::WriteStringToFile(content, path_)) {
2807 MYLOGE("Could not save stats on %s\n", path_.c_str());
2808 }
2809}
2810
2811int32_t Progress::Get() const {
2812 return progress_;
2813}
2814
2815bool Progress::Inc(int32_t delta_sec) {
2816 bool changed = false;
2817 if (delta_sec >= 0) {
2818 progress_ += delta_sec;
2819 if (progress_ > max_) {
2820 int32_t old_max = max_;
2821 max_ = floor((float)progress_ * growth_factor_);
2822 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
2823 changed = true;
2824 }
2825 }
2826 return changed;
2827}
2828
2829int32_t Progress::GetMax() const {
2830 return max_;
2831}
2832
2833int32_t Progress::GetInitialMax() const {
2834 return initial_max_;
2835}
2836
2837void Progress::Dump(int fd, const std::string& prefix) const {
2838 const char* pr = prefix.c_str();
2839 dprintf(fd, "%sprogress: %d\n", pr, progress_);
2840 dprintf(fd, "%smax: %d\n", pr, max_);
2841 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
2842 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
2843 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
2844 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
2845 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
2846}
2847
2848bool Dumpstate::IsZipping() const {
2849 return zip_writer_ != nullptr;
2850}
2851
2852std::string Dumpstate::GetPath(const std::string& suffix) const {
2853 return GetPath(bugreport_internal_dir_, suffix);
2854}
2855
2856std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
2857 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
2858 name_.c_str(), suffix.c_str());
2859}
2860
2861void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
2862 progress_ = std::move(progress);
2863}
2864
2865void for_each_userid(void (*func)(int), const char *header) {
2866 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
2867 "for_each_userid(%s)", header);
2868 DurationReporter duration_reporter(title);
2869 if (PropertiesHelper::IsDryRun()) return;
2870
2871 DIR *d;
2872 struct dirent *de;
2873
2874 if (header) printf("\n------ %s ------\n", header);
2875 func(0);
2876
2877 if (!(d = opendir("/data/system/users"))) {
2878 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
2879 return;
2880 }
2881
2882 while ((de = readdir(d))) {
2883 int userid;
2884 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
2885 continue;
2886 }
2887 func(userid);
2888 }
2889
2890 closedir(d);
2891}
2892
2893static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
2894 DIR *d;
2895 struct dirent *de;
2896
2897 if (!(d = opendir("/proc"))) {
2898 printf("Failed to open /proc (%s)\n", strerror(errno));
2899 return;
2900 }
2901
2902 if (header) printf("\n------ %s ------\n", header);
2903 while ((de = readdir(d))) {
2904 if (ds.IsUserConsentDenied()) {
2905 MYLOGE(
2906 "Returning early because user denied consent to share bugreport with calling app.");
2907 closedir(d);
2908 return;
2909 }
2910 int pid;
2911 int fd;
2912 char cmdpath[255];
2913 char cmdline[255];
2914
2915 if (!(pid = atoi(de->d_name))) {
2916 continue;
2917 }
2918
2919 memset(cmdline, 0, sizeof(cmdline));
2920
2921 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
2922 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2923 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
2924 close(fd);
2925 if (cmdline[0]) {
2926 helper(pid, cmdline, arg);
2927 continue;
2928 }
2929 }
2930
2931 // if no cmdline, a kernel thread has comm
2932 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
2933 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2934 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
2935 close(fd);
2936 if (cmdline[1]) {
2937 cmdline[0] = '[';
2938 size_t len = strcspn(cmdline, "\f\b\r\n");
2939 cmdline[len] = ']';
2940 cmdline[len+1] = '\0';
2941 }
2942 }
2943 if (!cmdline[0]) {
2944 strcpy(cmdline, "N/A");
2945 }
2946 helper(pid, cmdline, arg);
2947 }
2948
2949 closedir(d);
2950}
2951
2952static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
2953 for_each_pid_func *func = (for_each_pid_func*) arg;
2954 func(pid, cmdline);
2955}
2956
2957void for_each_pid(for_each_pid_func func, const char *header) {
2958 std::string title = header == nullptr ? "for_each_pid"
2959 : android::base::StringPrintf("for_each_pid(%s)", header);
2960 DurationReporter duration_reporter(title);
2961 if (PropertiesHelper::IsDryRun()) return;
2962
2963 __for_each_pid(for_each_pid_helper, header, (void *) func);
2964}
2965
2966static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
2967 DIR *d;
2968 struct dirent *de;
2969 char taskpath[255];
2970 for_each_tid_func *func = (for_each_tid_func *) arg;
2971
2972 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
2973
2974 if (!(d = opendir(taskpath))) {
2975 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
2976 return;
2977 }
2978
2979 func(pid, pid, cmdline);
2980
2981 while ((de = readdir(d))) {
2982 if (ds.IsUserConsentDenied()) {
2983 MYLOGE(
2984 "Returning early because user denied consent to share bugreport with calling app.");
2985 closedir(d);
2986 return;
2987 }
2988 int tid;
2989 int fd;
2990 char commpath[255];
2991 char comm[255];
2992
2993 if (!(tid = atoi(de->d_name))) {
2994 continue;
2995 }
2996
2997 if (tid == pid)
2998 continue;
2999
3000 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3001 memset(comm, 0, sizeof(comm));
3002 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3003 strcpy(comm, "N/A");
3004 } else {
3005 char *c;
3006 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3007 close(fd);
3008
3009 c = strrchr(comm, '\n');
3010 if (c) {
3011 *c = '\0';
3012 }
3013 }
3014 func(pid, tid, comm);
3015 }
3016
3017 closedir(d);
3018}
3019
3020void for_each_tid(for_each_tid_func func, const char *header) {
3021 std::string title = header == nullptr ? "for_each_tid"
3022 : android::base::StringPrintf("for_each_tid(%s)", header);
3023 DurationReporter duration_reporter(title);
3024
3025 if (PropertiesHelper::IsDryRun()) return;
3026
3027 __for_each_pid(for_each_tid_helper, header, (void *) func);
3028}
3029
3030void show_wchan(int pid, int tid, const char *name) {
3031 if (PropertiesHelper::IsDryRun()) return;
3032
3033 char path[255];
3034 char buffer[255];
3035 int fd, ret, save_errno;
3036 char name_buffer[255];
3037
3038 memset(buffer, 0, sizeof(buffer));
3039
3040 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3041 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3042 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3043 return;
3044 }
3045
3046 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3047 save_errno = errno;
3048 close(fd);
3049
3050 if (ret < 0) {
3051 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3052 return;
3053 }
3054
3055 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3056 pid == tid ? 0 : 3, "", name);
3057
3058 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3059
3060 return;
3061}
3062
3063// print time in centiseconds
3064static void snprcent(char *buffer, size_t len, size_t spc,
3065 unsigned long long time) {
3066 static long hz; // cache discovered hz
3067
3068 if (hz <= 0) {
3069 hz = sysconf(_SC_CLK_TCK);
3070 if (hz <= 0) {
3071 hz = 1000;
3072 }
3073 }
3074
3075 // convert to centiseconds
3076 time = (time * 100 + (hz / 2)) / hz;
3077
3078 char str[16];
3079
3080 snprintf(str, sizeof(str), " %llu.%02u",
3081 time / 100, (unsigned)(time % 100));
3082 size_t offset = strlen(buffer);
3083 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3084 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3085}
3086
3087// print permille as a percent
3088static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3089 char str[16];
3090
3091 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3092 size_t offset = strlen(buffer);
3093 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3094 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3095}
3096
3097void show_showtime(int pid, const char *name) {
3098 if (PropertiesHelper::IsDryRun()) return;
3099
3100 char path[255];
3101 char buffer[1023];
3102 int fd, ret, save_errno;
3103
3104 memset(buffer, 0, sizeof(buffer));
3105
3106 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3107 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3108 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3109 return;
3110 }
3111
3112 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3113 save_errno = errno;
3114 close(fd);
3115
3116 if (ret < 0) {
3117 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3118 return;
3119 }
3120
3121 // field 14 is utime
3122 // field 15 is stime
3123 // field 42 is iotime
3124 unsigned long long utime = 0, stime = 0, iotime = 0;
3125 if (sscanf(buffer,
3126 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3127 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3128 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3129 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3130 &utime, &stime, &iotime) != 3) {
3131 return;
3132 }
3133
3134 unsigned long long total = utime + stime;
3135 if (!total) {
3136 return;
3137 }
3138
3139 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3140 if (permille > 1000) {
3141 permille = 1000;
3142 }
3143
3144 // try to beautify and stabilize columns at <80 characters
3145 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3146 if ((name[0] != '[') || utime) {
3147 snprcent(buffer, sizeof(buffer), 57, utime);
3148 }
3149 snprcent(buffer, sizeof(buffer), 65, stime);
3150 if ((name[0] != '[') || iotime) {
3151 snprcent(buffer, sizeof(buffer), 73, iotime);
3152 }
3153 if (iotime) {
3154 snprdec(buffer, sizeof(buffer), 79, permille);
3155 }
3156 puts(buffer); // adds a trailing newline
3157
3158 return;
3159}
3160
3161void do_dmesg() {
3162 const char *title = "KERNEL LOG (dmesg)";
3163 DurationReporter duration_reporter(title);
3164 printf("------ %s ------\n", title);
3165
3166 if (PropertiesHelper::IsDryRun()) return;
3167
3168 /* Get size of kernel buffer */
3169 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3170 if (size <= 0) {
3171 printf("Unexpected klogctl return value: %d\n\n", size);
3172 return;
3173 }
3174 char *buf = (char *) malloc(size + 1);
3175 if (buf == nullptr) {
3176 printf("memory allocation failed\n\n");
3177 return;
3178 }
3179 int retval = klogctl(KLOG_READ_ALL, buf, size);
3180 if (retval < 0) {
3181 printf("klogctl failure\n\n");
3182 free(buf);
3183 return;
3184 }
3185 buf[retval] = '\0';
3186 printf("%s\n\n", buf);
3187 free(buf);
3188 return;
3189}
3190
3191void do_showmap(int pid, const char *name) {
3192 char title[255];
3193 char arg[255];
3194
3195 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3196 snprintf(arg, sizeof(arg), "%d", pid);
3197 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3198}
3199
3200int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3201 DurationReporter duration_reporter(title);
3202
3203 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3204
3205 UpdateProgress(WEIGHT_FILE);
3206
3207 return status;
3208}
3209
3210int read_file_as_long(const char *path, long int *output) {
3211 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3212 if (fd < 0) {
3213 int err = errno;
3214 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3215 return -1;
3216 }
3217 char buffer[50];
3218 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3219 if (bytes_read == -1) {
3220 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3221 return -2;
3222 }
3223 if (bytes_read == 0) {
3224 MYLOGE("File %s is empty\n", path);
3225 return -3;
3226 }
3227 *output = atoi(buffer);
3228 return 0;
3229}
3230
3231/* calls skip to gate calling dump_from_fd recursively
3232 * in the specified directory. dump_from_fd defaults to
3233 * dump_file_from_fd above when set to NULL. skip defaults
3234 * to false when set to NULL. dump_from_fd will always be
3235 * called with title NULL.
3236 */
3237int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3238 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3239 DurationReporter duration_reporter(title);
3240 DIR *dirp;
3241 struct dirent *d;
3242 char *newpath = nullptr;
3243 const char *slash = "/";
3244 int retval = 0;
3245
3246 if (!title.empty()) {
3247 printf("------ %s (%s) ------\n", title.c_str(), dir);
3248 }
3249 if (PropertiesHelper::IsDryRun()) return 0;
3250
3251 if (dir[strlen(dir) - 1] == '/') {
3252 ++slash;
3253 }
3254 dirp = opendir(dir);
3255 if (dirp == nullptr) {
3256 retval = -errno;
3257 MYLOGE("%s: %s\n", dir, strerror(errno));
3258 return retval;
3259 }
3260
3261 if (!dump_from_fd) {
3262 dump_from_fd = dump_file_from_fd;
3263 }
3264 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3265 if ((d->d_name[0] == '.')
3266 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3267 || (d->d_name[1] == '\0'))) {
3268 continue;
3269 }
3270 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3271 (d->d_type == DT_DIR) ? "/" : "");
3272 if (!newpath) {
3273 retval = -errno;
3274 continue;
3275 }
3276 if (skip && (*skip)(newpath)) {
3277 continue;
3278 }
3279 if (d->d_type == DT_DIR) {
3280 int ret = dump_files("", newpath, skip, dump_from_fd);
3281 if (ret < 0) {
3282 retval = ret;
3283 }
3284 continue;
3285 }
3286 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3287 if (fd.get() < 0) {
3288 retval = -1;
3289 printf("*** %s: %s\n", newpath, strerror(errno));
3290 continue;
3291 }
3292 (*dump_from_fd)(nullptr, newpath, fd.get());
3293 }
3294 closedir(dirp);
3295 if (!title.empty()) {
3296 printf("\n");
3297 }
3298 return retval;
3299}
3300
3301/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3302 * it's possible to avoid issues where opening the file itself can get
3303 * stuck.
3304 */
3305int dump_file_from_fd(const char *title, const char *path, int fd) {
3306 if (PropertiesHelper::IsDryRun()) return 0;
3307
3308 int flags = fcntl(fd, F_GETFL);
3309 if (flags == -1) {
3310 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3311 return -1;
3312 } else if (!(flags & O_NONBLOCK)) {
3313 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3314 return -1;
3315 }
3316 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3317}
3318
3319int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003320 const CommandOptions& options, bool verbose_duration) {
3321 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003322
3323 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3324
3325 /* TODO: for now we're simplifying the progress calculation by using the
3326 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3327 * where its weight should be much higher proportionally to its timeout.
3328 * Ideally, it should use a options.EstimatedDuration() instead...*/
3329 UpdateProgress(options.Timeout());
3330
3331 return status;
3332}
3333
3334void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3335 const CommandOptions& options, long dumpsysTimeoutMs) {
3336 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3337 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3338 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3339 RunCommand(title, dumpsys, options);
3340}
3341
3342int open_socket(const char *service) {
3343 int s = android_get_control_socket(service);
3344 if (s < 0) {
3345 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3346 return -1;
3347 }
3348 fcntl(s, F_SETFD, FD_CLOEXEC);
3349
3350 // Set backlog to 0 to make sure that queue size will be minimum.
3351 // In Linux, because the minimum queue will be 1, connect() will be blocked
3352 // if the other clients already called connect() and the connection request was not accepted.
3353 if (listen(s, 0) < 0) {
3354 MYLOGE("listen(control socket): %s\n", strerror(errno));
3355 return -1;
3356 }
3357
3358 struct sockaddr addr;
3359 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003360 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003361
3362 // Close socket just after accept(), to make sure that connect() by client will get error
3363 // when the socket is used by the other services.
3364 // There is still a race condition possibility between accept and close, but there is no way
3365 // to close-on-accept atomically.
3366 // See detail; b/123306389#comment25
3367 close(s);
3368
3369 if (fd < 0) {
3370 MYLOGE("accept(control socket): %s\n", strerror(errno));
3371 return -1;
3372 }
3373
3374 return fd;
3375}
3376
3377/* redirect output to a service control socket */
3378bool redirect_to_socket(FILE* redirect, const char* service) {
3379 int fd = open_socket(service);
3380 if (fd == -1) {
3381 return false;
3382 }
3383 fflush(redirect);
3384 // TODO: handle dup2 failure
3385 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3386 close(fd);
3387 return true;
3388}
3389
3390// TODO: should call is_valid_output_file and/or be merged into it.
3391void create_parent_dirs(const char *path) {
3392 char *chp = const_cast<char *> (path);
3393
3394 /* skip initial slash */
3395 if (chp[0] == '/')
3396 chp++;
3397
3398 /* create leading directories, if necessary */
3399 struct stat dir_stat;
3400 while (chp && chp[0]) {
3401 chp = strchr(chp, '/');
3402 if (chp) {
3403 *chp = 0;
3404 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3405 MYLOGI("Creating directory %s\n", path);
3406 if (mkdir(path, 0770)) { /* drwxrwx--- */
3407 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3408 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3409 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3410 }
3411 }
3412 *chp++ = '/';
3413 }
3414 }
3415}
3416
3417bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3418 create_parent_dirs(path);
3419
3420 int fd = TEMP_FAILURE_RETRY(open(path,
3421 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3422 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3423 if (fd < 0) {
3424 MYLOGE("%s: %s\n", path, strerror(errno));
3425 return false;
3426 }
3427
3428 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3429 close(fd);
3430 return true;
3431}
3432
3433bool redirect_to_file(FILE* redirect, char* path) {
3434 return _redirect_to_file(redirect, path, O_TRUNC);
3435}
3436
3437bool redirect_to_existing_file(FILE* redirect, char* path) {
3438 return _redirect_to_file(redirect, path, O_APPEND);
3439}
3440
3441void dump_route_tables() {
3442 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3443 if (PropertiesHelper::IsDryRun()) return;
3444 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3445 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3446 FILE* fp = fopen(RT_TABLES_PATH, "re");
3447 if (!fp) {
3448 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3449 return;
3450 }
3451 char table[16];
3452 // Each line has an integer (the table number), a space, and a string (the table name). We only
3453 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3454 // Add a fixed max limit so this doesn't go awry.
3455 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3456 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3457 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3458 }
3459 fclose(fp);
3460}
3461
3462// TODO: make this function thread safe if sections are generated in parallel.
3463void Dumpstate::UpdateProgress(int32_t delta_sec) {
3464 if (progress_ == nullptr) {
3465 MYLOGE("UpdateProgress: progress_ not set\n");
3466 return;
3467 }
3468
3469 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01003470 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003471
3472 // ...but only notifiy listeners when necessary.
3473 if (!options_->do_progress_updates) return;
3474
3475 int progress = progress_->Get();
3476 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01003477 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003478
Nandana Dutt402a8392019-06-14 14:25:13 +01003479 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003480 return;
3481 }
Nandana Dutt402a8392019-06-14 14:25:13 +01003482 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003483
3484 if (control_socket_fd_ >= 0) {
3485 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3486 fsync(control_socket_fd_);
3487 }
3488
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003489 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003490 if (percent % 10 == 0) {
3491 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003492 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003493 } else {
3494 // stderr is ignored on normal invocations, but useful when calling
3495 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003496 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003497 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003498
3499 listener_->onProgress(percent);
3500 }
3501}
3502
3503void Dumpstate::TakeScreenshot(const std::string& path) {
3504 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3505 int status =
3506 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3507 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3508 if (status == 0) {
3509 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3510 } else {
3511 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3512 }
3513}
3514
3515bool is_dir(const char* pathname) {
3516 struct stat info;
3517 if (stat(pathname, &info) == -1) {
3518 return false;
3519 }
3520 return S_ISDIR(info.st_mode);
3521}
3522
3523time_t get_mtime(int fd, time_t default_mtime) {
3524 struct stat info;
3525 if (fstat(fd, &info) == -1) {
3526 return default_mtime;
3527 }
3528 return info.st_mtime;
3529}