blob: a20db24f43670508ee67210fe18276495150dfaa [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 {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800652 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000653}
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 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001548Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001549 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1550 // buffer.
1551 DoLogcat();
1552 // Capture timestamp after first logcat to use in next logcat
1553 time_t logcat_ts = time(nullptr);
1554
Nandana Dutt4be45d12018-09-26 15:04:23 +01001555 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001556 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001557
1558 /* Run some operations that require root. */
1559 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1560 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1561
1562 ds.AddDir(RECOVERY_DIR, true);
1563 ds.AddDir(RECOVERY_DATA_DIR, true);
1564 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1565 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1566 if (!PropertiesHelper::IsUserBuild()) {
1567 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1568 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1569 }
1570 add_mountinfo();
1571 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001572 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001573 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001574
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001575 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001576 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1577
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001578 // Dump IPsec stats. No keys are exposed here.
1579 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1580
Nandana Dutt4be45d12018-09-26 15:04:23 +01001581 // Run ss as root so we can see socket marks.
1582 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1583
1584 // Run iotop as root to show top 100 IO threads
1585 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1586
Erick Reyese68df822019-02-11 14:46:36 -08001587 // Gather shared memory buffer info if the product implements it
1588 struct stat st;
1589 if (!stat("/product/bin/dmabuf_dump", &st)) {
1590 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1591 }
1592
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001593 DumpFile("PSI cpu", "/proc/pressure/cpu");
1594 DumpFile("PSI memory", "/proc/pressure/memory");
1595 DumpFile("PSI io", "/proc/pressure/io");
1596
Nandana Dutt4be45d12018-09-26 15:04:23 +01001597 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001598 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001599 }
1600
Nandana Dutt5c390032019-03-12 10:52:56 +00001601 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001602 Dumpstate::RunStatus status = dumpstate();
1603 // Capture logcat since the last time we did it.
1604 DoSystemLogcat(logcat_ts);
1605 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001606}
1607
mukesh agrawal253dad42018-01-23 21:59:59 -08001608// This method collects common dumpsys for telephony and wifi
1609static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001610 DumpIpTablesAsRoot();
1611
Jayachandran Cb4389d92019-07-08 09:46:05 -07001612 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1613
Jayachandran Ca94c7172017-06-10 15:08:12 -07001614 if (!DropRootUser()) {
1615 return;
1616 }
1617
1618 do_dmesg();
1619 DoLogcat();
1620 DumpPacketStats();
1621 DoKmsg();
1622 DumpIpAddrAndRules();
1623 dump_route_tables();
Jayachandran Cb4389d92019-07-08 09:46:05 -07001624 DumpHals();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001625
1626 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1627 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001628}
1629
1630// This method collects dumpsys for telephony debugging only
1631static void DumpstateTelephonyOnly() {
1632 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001633
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001634 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001635
1636 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001637
1638 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1639
1640 printf("========================================================\n");
1641 printf("== Android Framework Services\n");
1642 printf("========================================================\n");
1643
Vishnu Nair652cc802017-11-30 15:18:30 -08001644 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1645 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001646 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1647 SEC_TO_MSEC(10));
1648 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001649 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1650 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001651 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1652 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001653 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1654 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001655
1656 printf("========================================================\n");
1657 printf("== Running Application Services\n");
1658 printf("========================================================\n");
1659
1660 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1661
1662 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001663 printf("== Running Application Services (non-platform)\n");
1664 printf("========================================================\n");
1665
1666 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1667 DUMPSYS_COMPONENTS_OPTIONS);
1668
1669 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001670 printf("== Checkins\n");
1671 printf("========================================================\n");
1672
1673 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1674
1675 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001676 printf("== dumpstate: done (id %d)\n", ds.id_);
1677 printf("========================================================\n");
1678}
1679
mukesh agrawal253dad42018-01-23 21:59:59 -08001680// This method collects dumpsys for wifi debugging only
1681static void DumpstateWifiOnly() {
1682 DurationReporter duration_reporter("DUMPSTATE");
1683
1684 DumpstateRadioCommon();
1685
1686 printf("========================================================\n");
1687 printf("== Android Framework Services\n");
1688 printf("========================================================\n");
1689
1690 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1691 SEC_TO_MSEC(10));
1692 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1693 SEC_TO_MSEC(10));
1694
1695 printf("========================================================\n");
1696 printf("== dumpstate: done (id %d)\n", ds.id_);
1697 printf("========================================================\n");
1698}
1699
Nandana Duttcf419a72019-03-14 10:40:17 +00001700Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001701 DurationReporter duration_reporter("DUMP TRACES");
1702
1703 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1704 const size_t buf_size = temp_file_pattern.length() + 1;
1705 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1706 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1707
1708 // Create a new, empty file to receive all trace dumps.
1709 //
1710 // TODO: This can be simplified once we remove support for the old style
1711 // dumps. We can have a file descriptor passed in to dump_traces instead
1712 // of creating a file, closing it and then reopening it again.
1713 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1714 if (fd < 0) {
1715 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001716 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001717 }
1718
1719 // Nobody should have access to this temporary file except dumpstate, but we
1720 // temporarily grant 'read' to 'others' here because this file is created
1721 // when tombstoned is still running as root, but dumped after dropping. This
1722 // can go away once support for old style dumping has.
1723 const int chmod_ret = fchmod(fd, 0666);
1724 if (chmod_ret < 0) {
1725 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001726 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001727 }
1728
1729 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1730 if (proc.get() == nullptr) {
1731 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001732 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001733 }
1734
1735 // Number of times process dumping has timed out. If we encounter too many
1736 // failures, we'll give up.
1737 int timeout_failures = 0;
1738 bool dalvik_found = false;
1739
1740 const std::set<int> hal_pids = get_interesting_hal_pids();
1741
1742 struct dirent* d;
1743 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001744 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001745 int pid = atoi(d->d_name);
1746 if (pid <= 0) {
1747 continue;
1748 }
1749
1750 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1751 std::string exe;
1752 if (!android::base::Readlink(link_name, &exe)) {
1753 continue;
1754 }
1755
1756 bool is_java_process;
1757 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1758 // Don't bother dumping backtraces for the zygote.
1759 if (IsZygote(pid)) {
1760 continue;
1761 }
1762
1763 dalvik_found = true;
1764 is_java_process = true;
1765 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1766 is_java_process = false;
1767 } else {
1768 // Probably a native process we don't care about, continue.
1769 continue;
1770 }
1771
1772 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1773 if (timeout_failures == 3) {
1774 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1775 break;
1776 }
1777
1778 const uint64_t start = Nanotime();
1779 const int ret = dump_backtrace_to_file_timeout(
1780 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1781 is_java_process ? 5 : 20, fd);
1782
1783 if (ret == -1) {
1784 // For consistency, the header and footer to this message match those
1785 // dumped by debuggerd in the success case.
1786 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1787 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1788 dprintf(fd, "---- end %d ----", pid);
1789 timeout_failures++;
1790 continue;
1791 }
1792
1793 // We've successfully dumped stack traces, reset the failure count
1794 // and write a summary of the elapsed time to the file and continue with the
1795 // next process.
1796 timeout_failures = 0;
1797
1798 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1799 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1800 }
1801
1802 if (!dalvik_found) {
1803 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1804 }
1805
Nandana Duttcf419a72019-03-14 10:40:17 +00001806 *path = file_name_buf.release();
1807 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001808}
1809
Felipe Leme6f674ae2016-11-18 17:10:33 -08001810void Dumpstate::DumpstateBoard() {
1811 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001812 printf("========================================================\n");
1813 printf("== Board\n");
1814 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001815
Felipe Leme6f674ae2016-11-18 17:10:33 -08001816 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001817 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001818 return;
1819 }
1820
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001821 std::vector<std::string> paths;
1822 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001823 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001824 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1825 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001826 remover.emplace_back(android::base::make_scope_guard(
1827 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001828 }
Jie Song9fbfad02017-06-20 16:29:42 -07001829
Wei Wang587eac92018-04-05 12:17:20 -07001830 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1831 if (dumpstate_device == nullptr) {
1832 MYLOGE("No IDumpstateDevice implementation\n");
1833 return;
1834 }
1835
1836 using ScopedNativeHandle =
1837 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1838 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1839 [](native_handle_t* handle) {
1840 native_handle_close(handle);
1841 native_handle_delete(handle);
1842 });
1843 if (handle == nullptr) {
1844 MYLOGE("Could not create native_handle\n");
1845 return;
1846 }
1847
Nandana Dutt5c390032019-03-12 10:52:56 +00001848 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001849 for (size_t i = 0; i < paths.size(); i++) {
1850 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1851
1852 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1853 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1854 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1855 if (fd < 0) {
1856 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1857 return;
1858 }
1859 handle.get()->data[i] = fd.release();
1860 }
1861
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001862 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001863 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1864 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1865 // and grab whatever dumped
1866 std::packaged_task<bool()>
1867 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001868 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1869 if (!status.isOk()) {
1870 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001871 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001872 }
Wei Wang587eac92018-04-05 12:17:20 -07001873 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001874 });
Wei Wang587eac92018-04-05 12:17:20 -07001875
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001876 auto result = dumpstate_task.get_future();
1877 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001878
1879 constexpr size_t timeout_sec = 30;
1880 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1881 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1882 if (!android::base::SetProperty("ctl.interface_restart",
1883 android::base::StringPrintf("%s/default",
1884 IDumpstateDevice::descriptor))) {
1885 MYLOGE("Couldn't restart dumpstate HAL\n");
1886 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001887 }
Wei Wang587eac92018-04-05 12:17:20 -07001888 // Wait some time for init to kill dumpstate vendor HAL
1889 constexpr size_t killing_timeout_sec = 10;
1890 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1891 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1892 "there might be racing in content\n", killing_timeout_sec);
1893 }
1894
1895 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1896 for (size_t i = 0; i < paths.size(); i++) {
1897 struct stat s;
1898 if (fstat(handle.get()->data[i], &s) == -1) {
1899 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1900 strerror(errno));
1901 file_sizes[i] = -1;
1902 continue;
1903 }
1904 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001905 }
1906
1907 for (size_t i = 0; i < paths.size(); i++) {
1908 if (file_sizes[i] == -1) {
1909 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001910 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001911 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001912 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001913 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001914 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001915 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001916 }
1917
Felipe Lemed8b94e52016-12-08 10:21:44 -08001918 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001919}
1920
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001921static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001922 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001923 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Abhijeet Kaure370d682019-10-01 16:49:30 +01001924 "[-z]] [-s] [-S] [-q] [-P] [-R] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001925 " -h: display this help message\n"
1926 " -b: play sound file instead of vibrate, at beginning of job\n"
1927 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001928 " -d: append date to filename\n"
1929 " -p: capture screenshot to filename.png\n"
1930 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001931 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001932 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001933 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01001934 " -P: send broadcast when started and do progress updates\n"
1935 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001936 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001937 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001938}
1939
Wei Liuf87959e2016-08-26 14:51:42 -07001940static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001941 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001942}
1943
Felipe Leme1d486fe2016-10-14 18:06:47 -07001944bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001945 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001946 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001947 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001948 // Final timestamp
1949 char date[80];
1950 time_t the_real_now_please_stand_up = time(nullptr);
1951 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001952 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001953 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001954
Felipe Leme9a523ae2016-10-20 15:10:33 -07001955 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001956 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001957 return false;
1958 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001959 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001960 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001961 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001962 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001963
Felipe Leme0f3fb202016-06-10 17:10:53 -07001964 // Add log file (which contains stderr output) to zip...
1965 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001966 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001967 MYLOGE("Failed to add dumpstate log to .zip file\n");
1968 return false;
1969 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001970 // TODO: Should truncate the existing file.
1971 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001972 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1973 return false;
1974 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001975 fprintf(stderr, "\n");
1976
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001977 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001978 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001979 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001980 return false;
1981 }
1982
Felipe Leme1d486fe2016-10-14 18:06:47 -07001983 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1984 ds.zip_file.reset(nullptr);
1985
Felipe Lemee9d2c542016-11-15 11:48:26 -08001986 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001987 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001988
Felipe Leme1e9edc62015-12-21 16:02:13 -08001989 return true;
1990}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001991
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001992static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1993 // clang-format off
1994 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1995 "--receiver-foreground", "--receiver-include-background", "-a", action};
1996 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001997
1998 am.insert(am.end(), args.begin(), args.end());
1999
Felipe Leme8d2410e2017-02-08 09:46:08 -08002000 RunCommand("", am,
2001 CommandOptions::WithTimeout(20)
2002 .Log("Sending broadcast: '%s'\n")
2003 .Always()
2004 .DropRoot()
2005 .RedirectStderr()
2006 .Build());
2007}
2008
Felipe Leme35b8cf12017-02-10 15:47:29 -08002009static void Vibrate(int duration_ms) {
2010 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002011 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002012 CommandOptions::WithTimeout(10)
2013 .Log("Vibrate: '%s'\n")
2014 .Always()
2015 .Build());
2016 // clang-format on
2017}
2018
Nandana Dutt979388e2018-11-30 16:48:55 +00002019static void MaybeResolveSymlink(std::string* path) {
2020 std::string resolved_path;
2021 if (android::base::Readlink(*path, &resolved_path)) {
2022 *path = resolved_path;
2023 }
2024}
2025
Nandana Dutt4be45d12018-09-26 15:04:23 +01002026/*
2027 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2028 * if we are writing zip files and adds the version file.
2029 */
2030static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002031 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2032
Nandana Dutt4be45d12018-09-26 15:04:23 +01002033 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2034 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002035 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002036 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002037 char date[80];
2038 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2039 ds.name_ = date;
2040 } else {
2041 ds.name_ = "undated";
2042 }
2043
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002044 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002045 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002046 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002047 ds.base_name_ += "-wifi";
2048 }
2049
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002050 if (ds.options_->do_fb) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002051 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.png" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002052 }
2053 ds.tmp_path_ = ds.GetPath(".tmp");
2054 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2055
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002056 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002057 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002058 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002059 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002060 "Bugreport dir: [%s] "
2061 "Base name: [%s] "
2062 "Suffix: [%s] "
2063 "Log path: [%s] "
2064 "Temporary path: [%s] "
2065 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002066 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2067 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002068
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002069 if (ds.options_->do_zip_file) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002070 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.zip" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002071 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2072 create_parent_dirs(ds.path_.c_str());
2073 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2074 if (ds.zip_file == nullptr) {
2075 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2076 } else {
2077 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2078 }
2079 ds.AddTextZipEntry("version.txt", ds.version_);
2080 }
2081}
2082
2083/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002084 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002085 * printing zipped file status, etc.
2086 */
2087static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002088 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002089 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002090 if (!ds.FinishZipFile()) {
2091 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2092 do_text_file = true;
2093 } else {
2094 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002095 }
2096 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002097 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002098 if (do_text_file) {
2099 dprintf(ds.control_socket_fd_,
2100 "FAIL:could not create zip file, check %s "
2101 "for more details\n",
2102 ds.log_path_.c_str());
2103 } else {
2104 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2105 }
2106 }
2107}
2108
Nandana Dutt4be45d12018-09-26 15:04:23 +01002109
Nandana Dutt58d72e22018-11-16 10:30:48 +00002110static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2111 switch (mode) {
2112 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2113 return "BUGREPORT_FULL";
2114 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2115 return "BUGREPORT_INTERACTIVE";
2116 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2117 return "BUGREPORT_REMOTE";
2118 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2119 return "BUGREPORT_WEAR";
2120 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2121 return "BUGREPORT_TELEPHONY";
2122 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2123 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002124 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2125 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002126 }
2127}
2128
2129static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002130 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002131 switch (mode) {
2132 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Nandana Dutt58d72e22018-11-16 10:30:48 +00002133 options->do_fb = true;
2134 break;
2135 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002136 // Currently, the dumpstate binder is only used by Shell to update progress.
2137 options->do_start_service = true;
2138 options->do_progress_updates = true;
2139 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002140 break;
2141 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002142 options->do_vibrate = false;
2143 options->is_remote_mode = true;
2144 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002145 break;
2146 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002147 options->do_start_service = true;
2148 options->do_progress_updates = true;
2149 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002150 options->do_fb = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002151 break;
2152 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002153 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002154 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002155 break;
2156 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002157 options->wifi_only = true;
2158 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002159 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002160 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002161 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2162 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002163 }
2164}
2165
Nandana Dutt58d72e22018-11-16 10:30:48 +00002166static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002167 MYLOGI(
2168 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_fb: %d "
2169 "is_remote_mode: %d show_header_only: %d do_start_service: %d telephony_only: %d "
2170 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s args: %s\n",
2171 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
2172 options.do_fb, options.is_remote_mode, options.show_header_only, options.do_start_service,
2173 options.telephony_only, options.wifi_only, options.do_progress_updates,
2174 options.bugreport_fd.get(), options.bugreport_mode.c_str(), options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002175}
2176
Nandana Dutt54dbd672019-01-11 12:58:05 +00002177void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2178 const android::base::unique_fd& bugreport_fd_in,
2179 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002180 // In the new API world, date is always added; output is always a zip file.
2181 // TODO(111441001): remove these options once they are obsolete.
2182 do_add_date = true;
2183 do_zip_file = true;
2184
Nandana Dutt54dbd672019-01-11 12:58:05 +00002185 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2186 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2187 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002188
Nandana Dutt58d72e22018-11-16 10:30:48 +00002189 SetOptionsFromMode(bugreport_mode, this);
2190}
2191
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002192Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2193 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002194 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002195 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002196 switch (c) {
2197 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002198 case 'd': do_add_date = true; break;
2199 case 'z': do_zip_file = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002200 case 's': use_socket = true; break;
2201 case 'S': use_control_socket = true; break;
2202 case 'v': show_header_only = true; break;
2203 case 'q': do_vibrate = false; break;
2204 case 'p': do_fb = true; break;
2205 case 'P': do_progress_updates = true; break;
2206 case 'R': is_remote_mode = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002207 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002208 case 'w':
2209 // This was already processed
2210 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002211 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002212 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002213 break;
2214 default:
2215 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002216 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002217 break;
2218 // clang-format on
2219 }
2220 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002221
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002222 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002223 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002224 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002225 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002226 }
2227 }
2228
2229 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2230 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002231
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002232 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002233}
2234
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002235bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002236 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002237 return false;
2238 }
2239
Abhijeet Kaure370d682019-10-01 16:49:30 +01002240 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002241 return false;
2242 }
2243
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002244 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002245 return false;
2246 }
2247
Abhijeet Kaure370d682019-10-01 16:49:30 +01002248 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002249 return false;
2250 }
2251 return true;
2252}
2253
Nandana Dutt197661d2018-11-16 16:40:21 +00002254void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2255 options_ = std::move(options);
2256}
2257
Nandana Duttd2f5f082019-01-18 17:13:52 +00002258Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2259 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002260 if (listener_ != nullptr) {
2261 switch (status) {
2262 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002263 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002264 break;
2265 case Dumpstate::RunStatus::HELP:
2266 break;
2267 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002268 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002269 break;
2270 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002271 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2272 break;
2273 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2274 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2275 break;
2276 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2277 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002278 break;
2279 }
2280 }
2281 return status;
2282}
2283
Nandana Dutt979388e2018-11-30 16:48:55 +00002284/*
2285 * Dumps relevant information to a bugreport based on the given options.
2286 *
2287 * The bugreport can be dumped to a file or streamed to a socket.
2288 *
2289 * How dumping to file works:
2290 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2291 * stderr is redirected a log file.
2292 *
2293 * The temporary bugreport is then populated via printfs, dumping contents of files and
2294 * output of commands to stdout.
2295 *
2296 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2297 * text file.
2298 *
2299 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2300 * gets added to the archive.
2301 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002302 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2303 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002304 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002305Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2306 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002307 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002308 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002309 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002310 return RunStatus::INVALID_INPUT;
2311 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002312 /* set as high priority, and protect from OOM killer */
2313 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002314
Felipe Lemed071c682016-10-20 16:48:00 -07002315 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002316 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002317 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002318 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002319 } else {
2320 /* fallback to kernels <= 2.6.35 */
2321 oom_adj = fopen("/proc/self/oom_adj", "we");
2322 if (oom_adj) {
2323 fputs("-17", oom_adj);
2324 fclose(oom_adj);
2325 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002326 }
2327
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002328 if (version_ == VERSION_DEFAULT) {
2329 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002330 }
2331
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002332 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002333 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002334 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002335 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002336 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002337 }
2338
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002339 if (options_->show_header_only) {
2340 PrintHeader();
2341 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002342 }
2343
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002344 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2345 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002346
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002347 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002348 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002349
2350 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002351 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002352 is_redirecting
2353 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2354 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002355 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002356
Felipe Lemed071c682016-10-20 16:48:00 -07002357 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002358 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002359 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002360 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2361
Sahana Raof35ed432019-07-12 10:47:52 +01002362 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2363 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2364 } else {
2365 // Wake lock will be released automatically on process death
2366 MYLOGD("Wake lock acquired.\n");
2367 }
2368
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002369 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002370
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002371 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002372 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002373 MYLOGI("Starting 'dumpstate' service\n");
2374 android::status_t ret;
2375 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2376 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2377 }
2378 }
2379
Felipe Lemef0292972016-11-22 13:57:05 -08002380 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002381 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2382 }
2383
Nandana Dutt235c6672019-11-14 15:22:32 +00002384 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2385 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002386
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002387 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002388
Christopher Ferrised9354f2014-10-01 17:35:01 -07002389 // If we are going to use a socket, do it as early as possible
2390 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002391 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002392 if (!redirect_to_socket(stdout, "dumpstate")) {
2393 return ERROR;
2394 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002395 }
2396
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002397 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002398 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002399 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002400 if (control_socket_fd_ == -1) {
2401 return ERROR;
2402 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002403 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002404 }
2405
Felipe Leme71bbfc52015-11-23 14:14:51 -08002406 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002407 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002408
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002409 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002410 // clang-format off
2411 std::vector<std::string> am_args = {
2412 "--receiver-permission", "android.permission.DUMP",
2413 };
2414 // clang-format on
2415 // Send STARTED broadcast for apps that listen to bugreport generation events
2416 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002417 if (options_->use_control_socket) {
2418 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002419 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002420 }
2421 }
2422
Nick Kralevichf3599b32016-01-25 15:05:16 -08002423 /* read /proc/cmdline before dropping root */
2424 FILE *cmdline = fopen("/proc/cmdline", "re");
2425 if (cmdline) {
2426 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2427 fclose(cmdline);
2428 }
2429
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002430 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002431 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002432 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002433
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002434 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002435 MYLOGI("taking early screenshot\n");
2436 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002437 }
2438
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002439 if (options_->do_zip_file && zip_file != nullptr) {
2440 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2441 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002442 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002443 }
2444 }
2445
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002446 int dup_stdout_fd;
2447 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002448 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002449 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002450 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002451 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2452 return ERROR;
2453 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002454 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2455 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2456 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002457 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002458
2459 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2460 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002461 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002462 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002463 /* TODO: rather than generating a text file now and zipping it later,
2464 it would be more efficient to redirect stdout to the zip entry
2465 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002466 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2467 return ERROR;
2468 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002469 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002470 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002471 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002472 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002473 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002474
2475 // Don't buffer stdout
2476 setvbuf(stdout, nullptr, _IONBF, 0);
2477
Felipe Leme608385d2016-02-01 10:35:38 -08002478 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2479 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002480 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002481 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002482
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002483 if (options_->telephony_only) {
Jichao Lie89d9c12019-11-21 19:02:51 -08002484 MaybeCheckUserConsent(calling_uid, calling_package);
Jayachandran Ca94c7172017-06-10 15:08:12 -07002485 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002486 DumpstateBoard();
2487 } else if (options_->wifi_only) {
Jichao Lie89d9c12019-11-21 19:02:51 -08002488 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002489 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002490 } else {
Jichao Lie89d9c12019-11-21 19:02:51 -08002491 // Invoking the critical dumpsys calls before DumpTraces() to try and
2492 // keep the system stats as close to its initial state as possible.
2493 RunDumpsysCritical();
2494
2495 // Run consent check only after critical dumpsys has finished -- so the consent
2496 // isn't going to pollute the system state / logs.
2497 MaybeCheckUserConsent(calling_uid, calling_package);
2498
Nandana Dutt4be45d12018-09-26 15:04:23 +01002499 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002500 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002501 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002502 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002503 HandleUserConsentDenied();
2504 }
2505 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002506 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002507 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002508
Felipe Leme55b42a62015-11-10 17:39:08 -08002509 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002510 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002511 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002512 }
2513
Abhijeet Kaure370d682019-10-01 16:49:30 +01002514 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002515 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002516 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002517 }
2518
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002519 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002520 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002521 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002522 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002523 if (status != Dumpstate::RunStatus::OK &&
2524 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2525 // Do an early return if there were errors. We make an exception for consent
2526 // timing out because it's possible the user got distracted. In this case the
2527 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002528 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002529 return status;
2530 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002531 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002532 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2533 options_->screenshot_fd.get());
2534 if (copy_succeeded) {
2535 android::os::UnlinkAndLogOnError(screenshot_path_);
2536 }
2537 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002538 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2539 MYLOGI(
2540 "Did not receive user consent yet."
2541 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002542 const String16 incidentcompanion("incidentcompanion");
2543 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2544 if (ics != nullptr) {
2545 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2546 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2547 consent_callback_.get());
2548 } else {
2549 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2550 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002551 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002552 }
2553
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002554 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002555 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002556 for (int i = 0; i < 3; i++) {
2557 Vibrate(75);
2558 usleep((75 + 50) * 1000);
2559 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002560 }
2561
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002562 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2563 progress_->GetInitialMax());
2564 progress_->Save();
2565 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002566
Felipe Leme107a05f2016-03-08 15:11:15 -08002567 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002568 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002569 }
2570
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002571 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002572 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002573 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002574 }
2575
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002576 tombstone_data_.clear();
2577 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002578
Nandana Duttd2f5f082019-01-18 17:13:52 +00002579 return (consent_callback_ != nullptr &&
2580 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2581 ? USER_CONSENT_TIMED_OUT
2582 : RunStatus::OK;
2583}
2584
Jichao Lie89d9c12019-11-21 19:02:51 -08002585void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
2586 if (calling_uid == AID_SHELL || !CalledByApi()) {
2587 // No need to get consent for shell triggered dumpstates, or not through
2588 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002589 return;
2590 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002591 consent_callback_ = new ConsentCallback();
2592 const String16 incidentcompanion("incidentcompanion");
2593 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08002594 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002595 if (ics != nullptr) {
2596 MYLOGD("Checking user consent via incidentcompanion service\n");
2597 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08002598 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07002599 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002600 } else {
2601 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2602 }
2603}
2604
Nandana Dutt5c390032019-03-12 10:52:56 +00002605bool Dumpstate::IsUserConsentDenied() const {
2606 return ds.consent_callback_ != nullptr &&
2607 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2608}
2609
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002610bool Dumpstate::CalledByApi() const {
2611 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2612}
2613
Nandana Duttd2f5f082019-01-18 17:13:52 +00002614void Dumpstate::CleanupFiles() {
2615 android::os::UnlinkAndLogOnError(tmp_path_);
2616 android::os::UnlinkAndLogOnError(screenshot_path_);
2617 android::os::UnlinkAndLogOnError(path_);
2618}
2619
2620Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2621 MYLOGD("User denied consent; deleting files and returning\n");
2622 CleanupFiles();
2623 return USER_CONSENT_DENIED;
2624}
2625
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002626Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002627 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002628 // user consent (unless the caller is Shell).
2629 UserConsentResult consent_result;
2630 if (calling_uid == AID_SHELL) {
2631 consent_result = UserConsentResult::APPROVED;
2632 } else {
2633 consent_result = consent_callback_->getResult();
2634 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002635 if (consent_result == UserConsentResult::UNAVAILABLE) {
2636 // User has not responded yet.
2637 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2638 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2639 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2640 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2641 sleep(delay_seconds);
2642 }
2643 consent_result = consent_callback_->getResult();
2644 }
2645 if (consent_result == UserConsentResult::DENIED) {
2646 // User has explicitly denied sharing with the app. To be safe delete the
2647 // internal bugreport & tmp files.
2648 return HandleUserConsentDenied();
2649 }
2650 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002651 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2652 if (copy_succeeded) {
2653 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002654 }
2655 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2656 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2657 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2658 // Since we do not have user consent to share the bugreport it does not get
2659 // copied over to the calling app but remains in the internal directory from
2660 // where the user can manually pull it.
2661 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2662 }
2663 // Unknown result; must be a programming error.
2664 MYLOGE("Unknown user consent result:%d\n", consent_result);
2665 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002666}
2667
Nandana Duttf02564e2019-02-15 15:24:24 +00002668Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002669 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2670 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2671 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002672 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002673 // When directly running dumpstate binary, the output is not expected to be written
2674 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002675 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002676
2677 // calling_uid and calling_package are for user consent to share the bugreport with
2678 // an app; they are irrelvant here because bugreport is only written to a local
2679 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002680 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002681 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002682 return status;
2683}
2684
2685/* Main entry point for dumpstate binary. */
2686int run_main(int argc, char* argv[]) {
2687 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002688
2689 switch (status) {
2690 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002691 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002692 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002693 ShowUsage();
2694 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002695 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002696 fprintf(stderr, "Invalid combination of args\n");
2697 ShowUsage();
2698 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002699 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002700 FALLTHROUGH_INTENDED;
2701 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2702 FALLTHROUGH_INTENDED;
2703 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002704 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002705 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002706}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002707
2708// TODO(111441001): Default DumpOptions to sensible values.
2709Dumpstate::Dumpstate(const std::string& version)
2710 : pid_(getpid()),
2711 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01002712 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002713 version_(version),
2714 now_(time(nullptr)) {
2715}
2716
2717Dumpstate& Dumpstate::GetInstance() {
2718 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2719 return singleton_;
2720}
2721
Nandana Dutt8d945c02019-08-14 13:30:07 +01002722DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2723 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002724 if (!title_.empty()) {
2725 started_ = Nanotime();
2726 }
2727}
2728
2729DurationReporter::~DurationReporter() {
2730 if (!title_.empty()) {
2731 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002732 if (elapsed >= .5f || verbose_) {
2733 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002734 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002735 if (!logcat_only_) {
2736 // Use "Yoda grammar" to make it easier to grep|sort sections.
2737 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002738 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002739 }
2740}
2741
2742const int32_t Progress::kDefaultMax = 5000;
2743
2744Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2745}
2746
2747Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2748 : Progress(initial_max, growth_factor, "") {
2749 progress_ = progress;
2750}
2751
2752Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2753 : initial_max_(initial_max),
2754 progress_(0),
2755 max_(initial_max),
2756 growth_factor_(growth_factor),
2757 n_runs_(0),
2758 average_max_(0),
2759 path_(path) {
2760 if (!path_.empty()) {
2761 Load();
2762 }
2763}
2764
2765void Progress::Load() {
2766 MYLOGD("Loading stats from %s\n", path_.c_str());
2767 std::string content;
2768 if (!android::base::ReadFileToString(path_, &content)) {
2769 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2770 return;
2771 }
2772 if (content.empty()) {
2773 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2774 return;
2775 }
2776 std::vector<std::string> lines = android::base::Split(content, "\n");
2777
2778 if (lines.size() < 1) {
2779 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2780 (int)lines.size(), max_);
2781 return;
2782 }
2783 char* ptr;
2784 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2785 average_max_ = strtol(ptr, nullptr, 10);
2786 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2787 average_max_ > STATS_MAX_AVERAGE) {
2788 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2789 initial_max_ = Progress::kDefaultMax;
2790 } else {
2791 initial_max_ = average_max_;
2792 }
2793 max_ = initial_max_;
2794
2795 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2796}
2797
2798void Progress::Save() {
2799 int32_t total = n_runs_ * average_max_ + progress_;
2800 int32_t runs = n_runs_ + 1;
2801 int32_t average = floor(((float)total) / runs);
2802 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2803 path_.c_str());
2804 if (path_.empty()) {
2805 return;
2806 }
2807
2808 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2809 if (!android::base::WriteStringToFile(content, path_)) {
2810 MYLOGE("Could not save stats on %s\n", path_.c_str());
2811 }
2812}
2813
2814int32_t Progress::Get() const {
2815 return progress_;
2816}
2817
2818bool Progress::Inc(int32_t delta_sec) {
2819 bool changed = false;
2820 if (delta_sec >= 0) {
2821 progress_ += delta_sec;
2822 if (progress_ > max_) {
2823 int32_t old_max = max_;
2824 max_ = floor((float)progress_ * growth_factor_);
2825 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
2826 changed = true;
2827 }
2828 }
2829 return changed;
2830}
2831
2832int32_t Progress::GetMax() const {
2833 return max_;
2834}
2835
2836int32_t Progress::GetInitialMax() const {
2837 return initial_max_;
2838}
2839
2840void Progress::Dump(int fd, const std::string& prefix) const {
2841 const char* pr = prefix.c_str();
2842 dprintf(fd, "%sprogress: %d\n", pr, progress_);
2843 dprintf(fd, "%smax: %d\n", pr, max_);
2844 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
2845 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
2846 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
2847 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
2848 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
2849}
2850
2851bool Dumpstate::IsZipping() const {
2852 return zip_writer_ != nullptr;
2853}
2854
2855std::string Dumpstate::GetPath(const std::string& suffix) const {
2856 return GetPath(bugreport_internal_dir_, suffix);
2857}
2858
2859std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
2860 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
2861 name_.c_str(), suffix.c_str());
2862}
2863
2864void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
2865 progress_ = std::move(progress);
2866}
2867
2868void for_each_userid(void (*func)(int), const char *header) {
2869 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
2870 "for_each_userid(%s)", header);
2871 DurationReporter duration_reporter(title);
2872 if (PropertiesHelper::IsDryRun()) return;
2873
2874 DIR *d;
2875 struct dirent *de;
2876
2877 if (header) printf("\n------ %s ------\n", header);
2878 func(0);
2879
2880 if (!(d = opendir("/data/system/users"))) {
2881 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
2882 return;
2883 }
2884
2885 while ((de = readdir(d))) {
2886 int userid;
2887 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
2888 continue;
2889 }
2890 func(userid);
2891 }
2892
2893 closedir(d);
2894}
2895
2896static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
2897 DIR *d;
2898 struct dirent *de;
2899
2900 if (!(d = opendir("/proc"))) {
2901 printf("Failed to open /proc (%s)\n", strerror(errno));
2902 return;
2903 }
2904
2905 if (header) printf("\n------ %s ------\n", header);
2906 while ((de = readdir(d))) {
2907 if (ds.IsUserConsentDenied()) {
2908 MYLOGE(
2909 "Returning early because user denied consent to share bugreport with calling app.");
2910 closedir(d);
2911 return;
2912 }
2913 int pid;
2914 int fd;
2915 char cmdpath[255];
2916 char cmdline[255];
2917
2918 if (!(pid = atoi(de->d_name))) {
2919 continue;
2920 }
2921
2922 memset(cmdline, 0, sizeof(cmdline));
2923
2924 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
2925 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2926 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
2927 close(fd);
2928 if (cmdline[0]) {
2929 helper(pid, cmdline, arg);
2930 continue;
2931 }
2932 }
2933
2934 // if no cmdline, a kernel thread has comm
2935 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
2936 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2937 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
2938 close(fd);
2939 if (cmdline[1]) {
2940 cmdline[0] = '[';
2941 size_t len = strcspn(cmdline, "\f\b\r\n");
2942 cmdline[len] = ']';
2943 cmdline[len+1] = '\0';
2944 }
2945 }
2946 if (!cmdline[0]) {
2947 strcpy(cmdline, "N/A");
2948 }
2949 helper(pid, cmdline, arg);
2950 }
2951
2952 closedir(d);
2953}
2954
2955static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
2956 for_each_pid_func *func = (for_each_pid_func*) arg;
2957 func(pid, cmdline);
2958}
2959
2960void for_each_pid(for_each_pid_func func, const char *header) {
2961 std::string title = header == nullptr ? "for_each_pid"
2962 : android::base::StringPrintf("for_each_pid(%s)", header);
2963 DurationReporter duration_reporter(title);
2964 if (PropertiesHelper::IsDryRun()) return;
2965
2966 __for_each_pid(for_each_pid_helper, header, (void *) func);
2967}
2968
2969static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
2970 DIR *d;
2971 struct dirent *de;
2972 char taskpath[255];
2973 for_each_tid_func *func = (for_each_tid_func *) arg;
2974
2975 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
2976
2977 if (!(d = opendir(taskpath))) {
2978 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
2979 return;
2980 }
2981
2982 func(pid, pid, cmdline);
2983
2984 while ((de = readdir(d))) {
2985 if (ds.IsUserConsentDenied()) {
2986 MYLOGE(
2987 "Returning early because user denied consent to share bugreport with calling app.");
2988 closedir(d);
2989 return;
2990 }
2991 int tid;
2992 int fd;
2993 char commpath[255];
2994 char comm[255];
2995
2996 if (!(tid = atoi(de->d_name))) {
2997 continue;
2998 }
2999
3000 if (tid == pid)
3001 continue;
3002
3003 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3004 memset(comm, 0, sizeof(comm));
3005 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3006 strcpy(comm, "N/A");
3007 } else {
3008 char *c;
3009 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3010 close(fd);
3011
3012 c = strrchr(comm, '\n');
3013 if (c) {
3014 *c = '\0';
3015 }
3016 }
3017 func(pid, tid, comm);
3018 }
3019
3020 closedir(d);
3021}
3022
3023void for_each_tid(for_each_tid_func func, const char *header) {
3024 std::string title = header == nullptr ? "for_each_tid"
3025 : android::base::StringPrintf("for_each_tid(%s)", header);
3026 DurationReporter duration_reporter(title);
3027
3028 if (PropertiesHelper::IsDryRun()) return;
3029
3030 __for_each_pid(for_each_tid_helper, header, (void *) func);
3031}
3032
3033void show_wchan(int pid, int tid, const char *name) {
3034 if (PropertiesHelper::IsDryRun()) return;
3035
3036 char path[255];
3037 char buffer[255];
3038 int fd, ret, save_errno;
3039 char name_buffer[255];
3040
3041 memset(buffer, 0, sizeof(buffer));
3042
3043 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3044 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3045 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3046 return;
3047 }
3048
3049 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3050 save_errno = errno;
3051 close(fd);
3052
3053 if (ret < 0) {
3054 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3055 return;
3056 }
3057
3058 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3059 pid == tid ? 0 : 3, "", name);
3060
3061 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3062
3063 return;
3064}
3065
3066// print time in centiseconds
3067static void snprcent(char *buffer, size_t len, size_t spc,
3068 unsigned long long time) {
3069 static long hz; // cache discovered hz
3070
3071 if (hz <= 0) {
3072 hz = sysconf(_SC_CLK_TCK);
3073 if (hz <= 0) {
3074 hz = 1000;
3075 }
3076 }
3077
3078 // convert to centiseconds
3079 time = (time * 100 + (hz / 2)) / hz;
3080
3081 char str[16];
3082
3083 snprintf(str, sizeof(str), " %llu.%02u",
3084 time / 100, (unsigned)(time % 100));
3085 size_t offset = strlen(buffer);
3086 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3087 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3088}
3089
3090// print permille as a percent
3091static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3092 char str[16];
3093
3094 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3095 size_t offset = strlen(buffer);
3096 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3097 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3098}
3099
3100void show_showtime(int pid, const char *name) {
3101 if (PropertiesHelper::IsDryRun()) return;
3102
3103 char path[255];
3104 char buffer[1023];
3105 int fd, ret, save_errno;
3106
3107 memset(buffer, 0, sizeof(buffer));
3108
3109 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3110 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3111 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3112 return;
3113 }
3114
3115 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3116 save_errno = errno;
3117 close(fd);
3118
3119 if (ret < 0) {
3120 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3121 return;
3122 }
3123
3124 // field 14 is utime
3125 // field 15 is stime
3126 // field 42 is iotime
3127 unsigned long long utime = 0, stime = 0, iotime = 0;
3128 if (sscanf(buffer,
3129 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3130 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3131 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3132 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3133 &utime, &stime, &iotime) != 3) {
3134 return;
3135 }
3136
3137 unsigned long long total = utime + stime;
3138 if (!total) {
3139 return;
3140 }
3141
3142 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3143 if (permille > 1000) {
3144 permille = 1000;
3145 }
3146
3147 // try to beautify and stabilize columns at <80 characters
3148 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3149 if ((name[0] != '[') || utime) {
3150 snprcent(buffer, sizeof(buffer), 57, utime);
3151 }
3152 snprcent(buffer, sizeof(buffer), 65, stime);
3153 if ((name[0] != '[') || iotime) {
3154 snprcent(buffer, sizeof(buffer), 73, iotime);
3155 }
3156 if (iotime) {
3157 snprdec(buffer, sizeof(buffer), 79, permille);
3158 }
3159 puts(buffer); // adds a trailing newline
3160
3161 return;
3162}
3163
3164void do_dmesg() {
3165 const char *title = "KERNEL LOG (dmesg)";
3166 DurationReporter duration_reporter(title);
3167 printf("------ %s ------\n", title);
3168
3169 if (PropertiesHelper::IsDryRun()) return;
3170
3171 /* Get size of kernel buffer */
3172 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3173 if (size <= 0) {
3174 printf("Unexpected klogctl return value: %d\n\n", size);
3175 return;
3176 }
3177 char *buf = (char *) malloc(size + 1);
3178 if (buf == nullptr) {
3179 printf("memory allocation failed\n\n");
3180 return;
3181 }
3182 int retval = klogctl(KLOG_READ_ALL, buf, size);
3183 if (retval < 0) {
3184 printf("klogctl failure\n\n");
3185 free(buf);
3186 return;
3187 }
3188 buf[retval] = '\0';
3189 printf("%s\n\n", buf);
3190 free(buf);
3191 return;
3192}
3193
3194void do_showmap(int pid, const char *name) {
3195 char title[255];
3196 char arg[255];
3197
3198 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3199 snprintf(arg, sizeof(arg), "%d", pid);
3200 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3201}
3202
3203int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3204 DurationReporter duration_reporter(title);
3205
3206 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3207
3208 UpdateProgress(WEIGHT_FILE);
3209
3210 return status;
3211}
3212
3213int read_file_as_long(const char *path, long int *output) {
3214 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3215 if (fd < 0) {
3216 int err = errno;
3217 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3218 return -1;
3219 }
3220 char buffer[50];
3221 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3222 if (bytes_read == -1) {
3223 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3224 return -2;
3225 }
3226 if (bytes_read == 0) {
3227 MYLOGE("File %s is empty\n", path);
3228 return -3;
3229 }
3230 *output = atoi(buffer);
3231 return 0;
3232}
3233
3234/* calls skip to gate calling dump_from_fd recursively
3235 * in the specified directory. dump_from_fd defaults to
3236 * dump_file_from_fd above when set to NULL. skip defaults
3237 * to false when set to NULL. dump_from_fd will always be
3238 * called with title NULL.
3239 */
3240int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3241 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3242 DurationReporter duration_reporter(title);
3243 DIR *dirp;
3244 struct dirent *d;
3245 char *newpath = nullptr;
3246 const char *slash = "/";
3247 int retval = 0;
3248
3249 if (!title.empty()) {
3250 printf("------ %s (%s) ------\n", title.c_str(), dir);
3251 }
3252 if (PropertiesHelper::IsDryRun()) return 0;
3253
3254 if (dir[strlen(dir) - 1] == '/') {
3255 ++slash;
3256 }
3257 dirp = opendir(dir);
3258 if (dirp == nullptr) {
3259 retval = -errno;
3260 MYLOGE("%s: %s\n", dir, strerror(errno));
3261 return retval;
3262 }
3263
3264 if (!dump_from_fd) {
3265 dump_from_fd = dump_file_from_fd;
3266 }
3267 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3268 if ((d->d_name[0] == '.')
3269 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3270 || (d->d_name[1] == '\0'))) {
3271 continue;
3272 }
3273 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3274 (d->d_type == DT_DIR) ? "/" : "");
3275 if (!newpath) {
3276 retval = -errno;
3277 continue;
3278 }
3279 if (skip && (*skip)(newpath)) {
3280 continue;
3281 }
3282 if (d->d_type == DT_DIR) {
3283 int ret = dump_files("", newpath, skip, dump_from_fd);
3284 if (ret < 0) {
3285 retval = ret;
3286 }
3287 continue;
3288 }
3289 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3290 if (fd.get() < 0) {
3291 retval = -1;
3292 printf("*** %s: %s\n", newpath, strerror(errno));
3293 continue;
3294 }
3295 (*dump_from_fd)(nullptr, newpath, fd.get());
3296 }
3297 closedir(dirp);
3298 if (!title.empty()) {
3299 printf("\n");
3300 }
3301 return retval;
3302}
3303
3304/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3305 * it's possible to avoid issues where opening the file itself can get
3306 * stuck.
3307 */
3308int dump_file_from_fd(const char *title, const char *path, int fd) {
3309 if (PropertiesHelper::IsDryRun()) return 0;
3310
3311 int flags = fcntl(fd, F_GETFL);
3312 if (flags == -1) {
3313 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3314 return -1;
3315 } else if (!(flags & O_NONBLOCK)) {
3316 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3317 return -1;
3318 }
3319 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3320}
3321
3322int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003323 const CommandOptions& options, bool verbose_duration) {
3324 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003325
3326 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3327
3328 /* TODO: for now we're simplifying the progress calculation by using the
3329 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3330 * where its weight should be much higher proportionally to its timeout.
3331 * Ideally, it should use a options.EstimatedDuration() instead...*/
3332 UpdateProgress(options.Timeout());
3333
3334 return status;
3335}
3336
3337void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3338 const CommandOptions& options, long dumpsysTimeoutMs) {
3339 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3340 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3341 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3342 RunCommand(title, dumpsys, options);
3343}
3344
3345int open_socket(const char *service) {
3346 int s = android_get_control_socket(service);
3347 if (s < 0) {
3348 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3349 return -1;
3350 }
3351 fcntl(s, F_SETFD, FD_CLOEXEC);
3352
3353 // Set backlog to 0 to make sure that queue size will be minimum.
3354 // In Linux, because the minimum queue will be 1, connect() will be blocked
3355 // if the other clients already called connect() and the connection request was not accepted.
3356 if (listen(s, 0) < 0) {
3357 MYLOGE("listen(control socket): %s\n", strerror(errno));
3358 return -1;
3359 }
3360
3361 struct sockaddr addr;
3362 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003363 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003364
3365 // Close socket just after accept(), to make sure that connect() by client will get error
3366 // when the socket is used by the other services.
3367 // There is still a race condition possibility between accept and close, but there is no way
3368 // to close-on-accept atomically.
3369 // See detail; b/123306389#comment25
3370 close(s);
3371
3372 if (fd < 0) {
3373 MYLOGE("accept(control socket): %s\n", strerror(errno));
3374 return -1;
3375 }
3376
3377 return fd;
3378}
3379
3380/* redirect output to a service control socket */
3381bool redirect_to_socket(FILE* redirect, const char* service) {
3382 int fd = open_socket(service);
3383 if (fd == -1) {
3384 return false;
3385 }
3386 fflush(redirect);
3387 // TODO: handle dup2 failure
3388 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3389 close(fd);
3390 return true;
3391}
3392
3393// TODO: should call is_valid_output_file and/or be merged into it.
3394void create_parent_dirs(const char *path) {
3395 char *chp = const_cast<char *> (path);
3396
3397 /* skip initial slash */
3398 if (chp[0] == '/')
3399 chp++;
3400
3401 /* create leading directories, if necessary */
3402 struct stat dir_stat;
3403 while (chp && chp[0]) {
3404 chp = strchr(chp, '/');
3405 if (chp) {
3406 *chp = 0;
3407 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3408 MYLOGI("Creating directory %s\n", path);
3409 if (mkdir(path, 0770)) { /* drwxrwx--- */
3410 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3411 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3412 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3413 }
3414 }
3415 *chp++ = '/';
3416 }
3417 }
3418}
3419
3420bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3421 create_parent_dirs(path);
3422
3423 int fd = TEMP_FAILURE_RETRY(open(path,
3424 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3425 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3426 if (fd < 0) {
3427 MYLOGE("%s: %s\n", path, strerror(errno));
3428 return false;
3429 }
3430
3431 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3432 close(fd);
3433 return true;
3434}
3435
3436bool redirect_to_file(FILE* redirect, char* path) {
3437 return _redirect_to_file(redirect, path, O_TRUNC);
3438}
3439
3440bool redirect_to_existing_file(FILE* redirect, char* path) {
3441 return _redirect_to_file(redirect, path, O_APPEND);
3442}
3443
3444void dump_route_tables() {
3445 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3446 if (PropertiesHelper::IsDryRun()) return;
3447 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3448 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3449 FILE* fp = fopen(RT_TABLES_PATH, "re");
3450 if (!fp) {
3451 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3452 return;
3453 }
3454 char table[16];
3455 // Each line has an integer (the table number), a space, and a string (the table name). We only
3456 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3457 // Add a fixed max limit so this doesn't go awry.
3458 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3459 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3460 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3461 }
3462 fclose(fp);
3463}
3464
3465// TODO: make this function thread safe if sections are generated in parallel.
3466void Dumpstate::UpdateProgress(int32_t delta_sec) {
3467 if (progress_ == nullptr) {
3468 MYLOGE("UpdateProgress: progress_ not set\n");
3469 return;
3470 }
3471
3472 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01003473 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003474
3475 // ...but only notifiy listeners when necessary.
3476 if (!options_->do_progress_updates) return;
3477
3478 int progress = progress_->Get();
3479 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01003480 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003481
Nandana Dutt402a8392019-06-14 14:25:13 +01003482 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003483 return;
3484 }
Nandana Dutt402a8392019-06-14 14:25:13 +01003485 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003486
3487 if (control_socket_fd_ >= 0) {
3488 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3489 fsync(control_socket_fd_);
3490 }
3491
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003492 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003493 if (percent % 10 == 0) {
3494 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003495 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003496 } else {
3497 // stderr is ignored on normal invocations, but useful when calling
3498 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003499 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003500 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003501
3502 listener_->onProgress(percent);
3503 }
3504}
3505
3506void Dumpstate::TakeScreenshot(const std::string& path) {
3507 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3508 int status =
3509 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3510 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3511 if (status == 0) {
3512 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3513 } else {
3514 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3515 }
3516}
3517
3518bool is_dir(const char* pathname) {
3519 struct stat info;
3520 if (stat(pathname, &info) == -1) {
3521 return false;
3522 }
3523 return S_ISDIR(info.st_mode);
3524}
3525
3526time_t get_mtime(int fd, time_t default_mtime) {
3527 struct stat info;
3528 if (fstat(fd, &info) == -1) {
3529 return default_mtime;
3530 }
3531 return info.st_mtime;
3532}