blob: aa627d767f9eae0574904e35c366cfa1b9bdb7f7 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080031#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070032#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <sys/resource.h>
34#include <sys/stat.h>
35#include <sys/time.h>
36#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010037#include <signal.h>
38#include <stdarg.h>
39#include <string.h>
40#include <sys/capability.h>
41#include <sys/inotify.h>
42#include <sys/klog.h>
43#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070044#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045
46#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070047#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000048#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <functional>
50#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010051#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070052#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <regex>
54#include <set>
55#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070056#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010057#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070058
Felipe Leme96c2bbb2016-09-26 09:21:21 -070059#include <android-base/file.h>
60#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070061#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080062#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070063#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070064#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010065#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080066#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080067#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000068#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010069#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080070#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070071#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010072#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000073#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080074#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010076#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080077#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010078#include <log/log.h>
Felipe Leme75876a22016-10-27 16:31:27 -070079#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070080#include <private/android_filesystem_config.h>
81#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070083#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080084#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070085#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070086#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080087
Steven Morelandcb7ef822016-11-29 13:20:37 -080088using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080089using ::std::literals::chrono_literals::operator""ms;
90using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080091
Felipe Leme47e9be22016-12-21 15:37:07 -080092// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080093using android::defaultServiceManager;
94using android::Dumpsys;
95using android::INVALID_OPERATION;
96using android::IServiceManager;
97using android::OK;
98using android::sp;
99using android::status_t;
100using android::String16;
101using android::String8;
102using android::TIMED_OUT;
103using android::UNKNOWN_ERROR;
104using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000105using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000106using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800107using android::os::dumpstate::CommandOptions;
108using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -0800109using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -0800110
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100111// Keep in sync with
112// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
113static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
114
115/* Most simple commands have 10 as timeout, so 5 is a good estimate */
116static const int32_t WEIGHT_FILE = 5;
117
118// TODO: temporary variables and functions used during C++ refactoring
119static Dumpstate& ds = Dumpstate::GetInstance();
120static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100121 const CommandOptions& options = CommandOptions::DEFAULT,
122 bool verbose_duration = false) {
123 return ds.RunCommand(title, full_command, options, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100124}
125
126// Reasonable value for max stats.
127static const int STATS_MAX_N_RUNS = 1000;
128static const long STATS_MAX_AVERAGE = 100000;
129
130CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
131
Nandana Duttd2f5f082019-01-18 17:13:52 +0000132typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
133
Colin Crossf45fa6b2012-03-26 12:38:26 -0700134/* read before root is shed */
135static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700136static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000137static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700138
Felipe Leme1d486fe2016-10-14 18:06:47 -0700139// TODO: variables and functions below should be part of dumpstate object
140
Felipe Leme635ca312016-01-05 14:23:02 -0800141static std::set<std::string> mount_points;
142void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800143
Todd Poynor2a83daa2013-11-22 15:44:22 -0800144#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700145#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700146#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800147
Felipe Lemee82a27d2016-01-05 13:35:44 -0800148#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700149#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700150#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700151#define LOGPERSIST_DATA_DIR "/data/misc/logd"
David Brazdild2991962016-06-03 14:40:44 +0100152#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
153#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800154#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900155#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800156#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700157#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800158#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900159#define LINKERCONFIG_DIR "/linkerconfig"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700160
Narayan Kamath8f788292017-05-25 13:20:39 +0100161// TODO(narayan): Since this information has to be kept in sync
162// with tombstoned, we should just put it in a common header.
163//
164// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100165static const std::string TOMBSTONE_DIR = "/data/tombstones/";
166static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
167static const std::string ANR_DIR = "/data/anr/";
168static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700169
Felipe Lemee844a9d2016-09-21 15:01:39 -0700170// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000171
Nandana Dutt5c390032019-03-12 10:52:56 +0000172#define RETURN_IF_USER_DENIED_CONSENT() \
173 if (ds.IsUserConsentDenied()) { \
174 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
175 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
176 }
177
178// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
179// if consent is found to be denied.
180#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
181 RETURN_IF_USER_DENIED_CONSENT(); \
182 func_ptr(__VA_ARGS__); \
183 RETURN_IF_USER_DENIED_CONSENT();
184
Sahana Raof35ed432019-07-12 10:47:52 +0100185static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
186
Nandana Dutt979388e2018-11-30 16:48:55 +0000187namespace android {
188namespace os {
189namespace {
190
191static int Open(std::string path, int flags, mode_t mode = 0) {
192 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
193 if (fd == -1) {
194 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
195 }
196 return fd;
197}
198
Nandana Dutt979388e2018-11-30 16:48:55 +0000199
200static int OpenForRead(std::string path) {
201 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
202}
203
204bool CopyFile(int in_fd, int out_fd) {
205 char buf[4096];
206 ssize_t byte_count;
207 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
208 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
209 return false;
210 }
211 }
212 return (byte_count != -1);
213}
214
215static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000216 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000217
218 // Obtain a handle to the source file.
219 android::base::unique_fd in_fd(OpenForRead(input_file));
220 if (out_fd != -1 && in_fd.get() != -1) {
221 if (CopyFile(in_fd.get(), out_fd)) {
222 return true;
223 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000224 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000225 }
226 return false;
227}
228
Nandana Duttd2f5f082019-01-18 17:13:52 +0000229static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000230 if (unlink(file.c_str())) {
231 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000232 return false;
233 }
234 return true;
235}
Nandana Dutt979388e2018-11-30 16:48:55 +0000236
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000237static bool IsFileEmpty(const std::string& file_path) {
238 std::ifstream file(file_path, std::ios::binary | std::ios::ate);
239 if(file.bad()) {
240 MYLOGE("Cannot open file: %s\n", file_path.c_str());
241 return true;
242 }
243 return file.tellg() <= 0;
244}
245
Nikita Ioffea325a572019-05-16 19:49:47 +0100246int64_t GetModuleMetadataVersion() {
247 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
248 if (binder == nullptr) {
249 MYLOGE("Failed to retrieve package_native service");
250 return 0L;
251 }
252 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
253 std::string package_name;
254 auto status = package_service->getModuleMetadataPackageName(&package_name);
255 if (!status.isOk()) {
256 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
257 return 0L;
258 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100259 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100260 int64_t version_code;
261 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
262 &version_code);
263 if (!status.isOk()) {
264 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
265 return 0L;
266 }
267 return version_code;
268}
269
Nandana Dutt979388e2018-11-30 16:48:55 +0000270} // namespace
271} // namespace os
272} // namespace android
273
Felipe Leme678727a2016-09-21 17:22:11 -0700274static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800275 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800276 long dumpsysTimeoutMs = 0) {
277 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700278}
279static int DumpFile(const std::string& title, const std::string& path) {
280 return ds.DumpFile(title, path);
281}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800282
Felipe Lemee844a9d2016-09-21 15:01:39 -0700283// Relative directory (inside the zip) for all files copied as-is into the bugreport.
284static const std::string ZIP_ROOT_DIR = "FS";
285
Vishnu Naire97d6122018-01-18 13:58:56 -0800286static const std::string kProtoPath = "proto/";
287static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700288static const std::string kDumpstateBoardFiles[] = {
289 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700290 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700291};
292static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
293
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700294static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700295static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700296static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700297static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
298static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700299
Felipe Lemef0292972016-11-22 13:57:05 -0800300static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
301
Narayan Kamath8f788292017-05-25 13:20:39 +0100302/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100303 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
304 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
305 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100306 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700307static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
308 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700309 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100310 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
311
Narayan Kamathbd863722017-06-01 18:50:12 +0100312 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100313
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700314 if (dump_dir == nullptr) {
315 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700316 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700317 }
318
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700319 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100320 struct dirent* entry = nullptr;
321 while ((entry = readdir(dump_dir.get()))) {
322 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100323 continue;
324 }
325
Narayan Kamathbd863722017-06-01 18:50:12 +0100326 const std::string base_name(entry->d_name);
327 if (base_name.find(file_prefix) != 0) {
328 continue;
329 }
330
331 const std::string abs_path = dir_path + base_name;
332 android::base::unique_fd fd(
333 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
334 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700335 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100336 break;
337 }
338
339 struct stat st = {};
340 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700341 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100342 continue;
343 }
344
Narayan Kamath3f31b632018-02-22 19:42:36 +0000345 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100346 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100347 continue;
348 }
349
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700350 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700351 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100352
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700353 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100354}
355
Narayan Kamathbd863722017-06-01 18:50:12 +0100356static bool AddDumps(const std::vector<DumpData>::const_iterator start,
357 const std::vector<DumpData>::const_iterator end,
358 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100359 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100360 for (auto it = start; it != end; ++it) {
361 const std::string& name = it->name;
362 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100363 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100364
365 // Seek to the beginning of the file before dumping any data. A given
366 // DumpData entry might be dumped multiple times in the report.
367 //
368 // For example, the most recent ANR entry is dumped to the body of the
369 // main entry and it also shows up as a separate entry in the bugreport
370 // ZIP file.
371 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
372 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
373 strerror(errno));
374 }
375
Narayan Kamath8f788292017-05-25 13:20:39 +0100376 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800377 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100378 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100379 }
380 } else {
381 dump_file_from_fd(type_name, name.c_str(), fd);
382 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100383 }
384
385 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700386}
387
Felipe Leme635ca312016-01-05 14:23:02 -0800388// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700389void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800390 char path[PATH_MAX];
391
392 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
393 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700394 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800395 char linkname[PATH_MAX];
396 ssize_t r = readlink(path, linkname, PATH_MAX);
397 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800398 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800399 return;
400 }
401 linkname[r] = '\0';
402
403 if (mount_points.find(linkname) == mount_points.end()) {
404 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700405 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700406 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800407 mount_points.insert(linkname);
408 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800409 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800410 }
411 }
412}
413
414void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700415 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700416 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800417 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800418 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700419 for_each_pid(do_mountinfo, nullptr);
420 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800421}
422
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700423static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
424{
425 DIR *d;
426 struct dirent *de;
427 char path[PATH_MAX];
428
429 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700430 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700431 return;
432 }
433
434 while ((de = readdir(d))) {
435 if (de->d_type != DT_LNK) {
436 continue;
437 }
438 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700439 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700440 }
441
442 closedir(d);
443}
444
Mark Salyzyn326842f2015-04-30 09:49:41 -0700445static bool skip_not_stat(const char *path) {
446 static const char stat[] = "/stat";
447 size_t len = strlen(path);
448 if (path[len - 1] == '/') { /* Directory? */
449 return false;
450 }
451 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
452}
453
Felipe Leme4c2d6632016-09-28 14:32:00 -0700454static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800455 return false;
456}
457
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700458unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700459
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800460//
461// stat offsets
462// Name units description
463// ---- ----- -----------
464// read I/Os requests number of read I/Os processed
465#define __STAT_READ_IOS 0
466// read merges requests number of read I/Os merged with in-queue I/O
467#define __STAT_READ_MERGES 1
468// read sectors sectors number of sectors read
469#define __STAT_READ_SECTORS 2
470// read ticks milliseconds total wait time for read requests
471#define __STAT_READ_TICKS 3
472// write I/Os requests number of write I/Os processed
473#define __STAT_WRITE_IOS 4
474// write merges requests number of write I/Os merged with in-queue I/O
475#define __STAT_WRITE_MERGES 5
476// write sectors sectors number of sectors written
477#define __STAT_WRITE_SECTORS 6
478// write ticks milliseconds total wait time for write requests
479#define __STAT_WRITE_TICKS 7
480// in_flight requests number of I/Os currently in flight
481#define __STAT_IN_FLIGHT 8
482// io_ticks milliseconds total time this block device has been active
483#define __STAT_IO_TICKS 9
484// time_in_queue milliseconds total wait time for all requests
485#define __STAT_IN_QUEUE 10
486#define __STAT_NUMBER_FIELD 11
487//
488// read I/Os, write I/Os
489// =====================
490//
491// These values increment when an I/O request completes.
492//
493// read merges, write merges
494// =========================
495//
496// These values increment when an I/O request is merged with an
497// already-queued I/O request.
498//
499// read sectors, write sectors
500// ===========================
501//
502// These values count the number of sectors read from or written to this
503// block device. The "sectors" in question are the standard UNIX 512-byte
504// sectors, not any device- or filesystem-specific block size. The
505// counters are incremented when the I/O completes.
506#define SECTOR_SIZE 512
507//
508// read ticks, write ticks
509// =======================
510//
511// These values count the number of milliseconds that I/O requests have
512// waited on this block device. If there are multiple I/O requests waiting,
513// these values will increase at a rate greater than 1000/second; for
514// example, if 60 read requests wait for an average of 30 ms, the read_ticks
515// field will increase by 60*30 = 1800.
516//
517// in_flight
518// =========
519//
520// This value counts the number of I/O requests that have been issued to
521// the device driver but have not yet completed. It does not include I/O
522// requests that are in the queue but not yet issued to the device driver.
523//
524// io_ticks
525// ========
526//
527// This value counts the number of milliseconds during which the device has
528// had I/O requests queued.
529//
530// time_in_queue
531// =============
532//
533// This value counts the number of milliseconds that I/O requests have waited
534// on this block device. If there are multiple I/O requests waiting, this
535// value will increase as the product of the number of milliseconds times the
536// number of requests waiting (see "read ticks" above for an example).
537#define S_TO_MS 1000
538//
539
Mark Salyzyn326842f2015-04-30 09:49:41 -0700540static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800541 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700542 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700543 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700544 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700545 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700546 getline(&buffer, &i, fp);
547 fclose(fp);
548 if (!buffer) {
549 return -errno;
550 }
551 i = strlen(buffer);
552 while ((i > 0) && (buffer[i - 1] == '\n')) {
553 buffer[--i] = '\0';
554 }
555 if (!*buffer) {
556 free(buffer);
557 return 0;
558 }
559 z = true;
560 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800561 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700562 if (fields[i] != 0) {
563 z = false;
564 }
565 }
566 if (z) { /* never accessed */
567 free(buffer);
568 return 0;
569 }
570
Wei Wang509bb5d2017-06-09 14:42:12 -0700571 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
572 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700573 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700574
575 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
576 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
577 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700578 free(buffer);
579
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800580 if (fields[__STAT_IO_TICKS]) {
581 unsigned long read_perf = 0;
582 unsigned long read_ios = 0;
583 if (fields[__STAT_READ_TICKS]) {
584 unsigned long long divisor = fields[__STAT_READ_TICKS]
585 * fields[__STAT_IO_TICKS];
586 read_perf = ((unsigned long long)SECTOR_SIZE
587 * fields[__STAT_READ_SECTORS]
588 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
589 / divisor;
590 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
591 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
592 / divisor;
593 }
594
595 unsigned long write_perf = 0;
596 unsigned long write_ios = 0;
597 if (fields[__STAT_WRITE_TICKS]) {
598 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
599 * fields[__STAT_IO_TICKS];
600 write_perf = ((unsigned long long)SECTOR_SIZE
601 * fields[__STAT_WRITE_SECTORS]
602 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
603 / divisor;
604 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
605 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
606 / divisor;
607 }
608
609 unsigned queue = (fields[__STAT_IN_QUEUE]
610 + (fields[__STAT_IO_TICKS] >> 1))
611 / fields[__STAT_IO_TICKS];
612
613 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700614 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800615 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700616 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800617 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800618 }
619
620 /* bugreport timeout factor adjustment */
621 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
622 worst_write_perf = write_perf;
623 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700624 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700625 return 0;
626}
627
Yao Chenbe3bbc12018-01-17 16:31:10 -0800628static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
629
630/* timeout in ms to read a list of buffers */
631static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
632 unsigned long timeout_ms = 0;
633 for (const auto& buffer : buffers) {
634 log_id_t id = android_name_to_log_id(buffer.c_str());
635 unsigned long property_size = __android_logger_get_buffer_size(id);
636 /* Engineering margin is ten-fold our guess */
637 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
638 }
639 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700640}
641
Nandana Duttd2f5f082019-01-18 17:13:52 +0000642Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
643}
644
645android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
646 std::lock_guard<std::mutex> lock(lock_);
647 result_ = APPROVED;
648 MYLOGD("User approved consent to share bugreport\n");
649 return android::binder::Status::ok();
650}
651
652android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
653 std::lock_guard<std::mutex> lock(lock_);
654 result_ = DENIED;
655 MYLOGW("User denied consent to share bugreport\n");
656 return android::binder::Status::ok();
657}
658
659UserConsentResult Dumpstate::ConsentCallback::getResult() {
660 std::lock_guard<std::mutex> lock(lock_);
661 return result_;
662}
663
664uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800665 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000666}
667
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700668void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700669 std::string build, fingerprint, radio, bootloader, network;
670 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700671
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700672 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
673 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700674 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
675 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
676 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700677 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700678
Felipe Lemed8b94e52016-12-08 10:21:44 -0800679 printf("========================================================\n");
680 printf("== dumpstate: %s\n", date);
681 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700682
Felipe Lemed8b94e52016-12-08 10:21:44 -0800683 printf("\n");
684 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700685 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800686 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
687 printf("Bootloader: %s\n", bootloader.c_str());
688 printf("Radio: %s\n", radio.c_str());
689 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100690 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
691 if (module_metadata_version != 0) {
692 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
693 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700694
Felipe Lemed8b94e52016-12-08 10:21:44 -0800695 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800696 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800697 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800698 printf("Uptime: ");
699 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
700 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800701 printf("Bugreport format version: %s\n", version_.c_str());
702 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s extra_options=%s\n", id_, pid_,
Nandana Dutt5fb117b2018-09-27 09:23:36 +0100703 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800704 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800705}
706
Felipe Leme24b66ee2016-06-16 10:55:26 -0700707// List of file extensions that can cause a zip file attachment to be rejected by some email
708// service providers.
709static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
710 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
711 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
712 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
713};
714
Vishnu Naire97d6122018-01-18 13:58:56 -0800715status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
716 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700717 if (!IsZipping()) {
718 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
719 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800720 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800721 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700722 std::string valid_name = entry_name;
723
724 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700725 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700726 if (idx != std::string::npos) {
727 std::string extension = entry_name.substr(idx);
728 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
729 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
730 valid_name = entry_name + ".renamed";
731 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
732 }
733 }
734
Felipe Leme6fe9db62016-02-12 09:04:16 -0800735 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
736 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700737 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
738 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700739 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700740 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700741 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800742 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800743 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000744 bool finished_entry = false;
745 auto finish_entry = [this, &finished_entry] {
746 if (!finished_entry) {
747 // This should only be called when we're going to return an earlier error,
748 // which would've been logged. This may imply the file is already corrupt
749 // and any further logging from FinishEntry is more likely to mislead than
750 // not.
751 this->zip_writer_->FinishEntry();
752 }
753 };
754 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800755 auto start = std::chrono::steady_clock::now();
756 auto end = start + timeout;
757 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800758
Felipe Leme770410d2016-01-26 17:07:14 -0800759 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800760 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800761 if (timeout.count() > 0) {
762 // lambda to recalculate the timeout.
763 auto time_left_ms = [end]() {
764 auto now = std::chrono::steady_clock::now();
765 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
766 return std::max(diff.count(), 0LL);
767 };
768
769 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
770 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000771 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
772 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800773 return -errno;
774 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000775 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800776 entry_name.c_str(), strerror(errno), timeout.count());
777 return TIMED_OUT;
778 }
779 }
780
Zach Riggle22200402016-08-18 01:01:24 -0400781 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800782 if (bytes_read == 0) {
783 break;
784 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800785 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800786 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800787 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700788 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800789 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700790 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800791 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800792 }
793 }
794
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700795 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000796 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700797 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700798 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800799 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800800 }
801
Vishnu Naire97d6122018-01-18 13:58:56 -0800802 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800803}
804
Felipe Leme1d486fe2016-10-14 18:06:47 -0700805bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
806 android::base::unique_fd fd(
807 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700808 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800809 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800810 return false;
811 }
812
Vishnu Naire97d6122018-01-18 13:58:56 -0800813 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800814}
815
816/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700817static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800818 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800819}
820
Felipe Leme1d486fe2016-10-14 18:06:47 -0700821void Dumpstate::AddDir(const std::string& dir, bool recursive) {
822 if (!IsZipping()) {
823 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800824 return;
825 }
Felipe Leme678727a2016-09-21 17:22:11 -0700826 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800827 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700828 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800829}
830
Felipe Leme1d486fe2016-10-14 18:06:47 -0700831bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
832 if (!IsZipping()) {
833 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
834 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800835 return false;
836 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800837 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700838 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700839 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700840 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700841 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800842 return false;
843 }
844
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700845 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700846 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700847 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700848 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800849 return false;
850 }
851
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700852 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700853 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700854 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800855 return false;
856 }
857
858 return true;
859}
860
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800861static void DoKmsg() {
862 struct stat st;
863 if (!stat(PSTORE_LAST_KMSG, &st)) {
864 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
865 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
866 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
867 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
868 } else {
869 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
870 DumpFile("LAST KMSG", "/proc/last_kmsg");
871 }
872}
873
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800874static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800875 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800876 RunCommand(
877 "KERNEL LOG",
878 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
879 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
880}
881
Nandana Duttdb379fa2019-10-09 16:54:41 +0100882static void DoSystemLogcat(time_t since) {
883 char since_str[80];
884 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
885
886 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
887 RunCommand("SYSTEM LOG",
888 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
889 since_str},
890 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
891}
892
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800893static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800894 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800895 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
896 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800897 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100898 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800899 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
900 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800901 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800902 RunCommand(
903 "EVENT LOG",
904 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100905 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800906 timeout_ms = logcat_timeout({"stats"});
907 RunCommand(
908 "STATS LOG",
909 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100910 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800911 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800912 RunCommand(
913 "RADIO LOG",
914 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100915 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800916
917 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
918
919 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800920 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
921 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800922}
923
Mike Ma5c267872019-08-21 11:31:34 -0700924static void DumpIncidentReport() {
925 if (!ds.IsZipping()) {
926 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
927 return;
928 }
929 DurationReporter duration_reporter("INCIDENT REPORT");
930 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
931 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
932 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
933 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
934 if (fd < 0) {
935 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
936 return;
937 }
938 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
939 bool empty = 0 == lseek(fd, 0, SEEK_END);
940 if (!empty) {
941 // Use a different name from "incident.proto"
942 // /proto/incident.proto is reserved for incident service dump
943 // i.e. metadata for debugging.
944 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
945 }
946 unlink(path.c_str());
947}
948
Jayachandran Ca94c7172017-06-10 15:08:12 -0700949static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700950 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
951 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900952 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700953 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900954 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
955 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
956 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
957 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700958}
959
David Andersond9ba4752018-12-11 18:26:59 -0800960static void DumpDynamicPartitionInfo() {
961 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
962 return;
963 }
964
965 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -0700966 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -0800967}
968
Narayan Kamath8f788292017-05-25 13:20:39 +0100969static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
970 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
971 anr_traces_dir.c_str());
972
973 // If we're here, dump_traces_path will always be a temporary file
974 // (created with mkostemp or similar) that contains dumps taken earlier
975 // on in the process.
976 if (dump_traces_path != nullptr) {
977 if (add_to_zip) {
978 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
979 } else {
980 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
981 dump_traces_path);
982 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
983 }
984
985 const int ret = unlink(dump_traces_path);
986 if (ret == -1) {
987 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
988 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700989 }
990 }
991
Narayan Kamathbd863722017-06-01 18:50:12 +0100992 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700993 if (ds.anr_data_.size() > 0) {
994 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100995 "VM TRACES AT LAST ANR", add_to_zip);
996
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100997 // The "last" ANR will always be included as separate entry in the zip file. In addition,
998 // it will be present in the body of the main entry if |add_to_zip| == false.
999 //
1000 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001001 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001002 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001003 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001004 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1005 }
1006}
1007
1008static void AddAnrTraceFiles() {
1009 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1010
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001011 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001012
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001013 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001014
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001015 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1016
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001017 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001018 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001019 int i = 0;
1020 while (true) {
1021 const std::string slow_trace_path =
1022 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1023 if (stat(slow_trace_path.c_str(), &st)) {
1024 // No traces file at this index, done with the files.
1025 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001026 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001027 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1028 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001029 }
1030}
1031
Wei Wang509bb5d2017-06-09 14:42:12 -07001032static void DumpBlockStatFiles() {
1033 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001034
Wei Wang1dc1ef52017-06-12 11:28:37 -07001035 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1036
1037 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001038 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1039 return;
1040 }
1041
1042 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001043 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001044 if ((d->d_name[0] == '.')
1045 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1046 || (d->d_name[1] == '\0'))) {
1047 continue;
1048 }
1049 const std::string new_path =
1050 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1051 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1052 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1053 printf("\n");
1054 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001055 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001056}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001057
1058static void DumpPacketStats() {
1059 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1060 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1061 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1062 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1063 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1064}
1065
1066static void DumpIpAddrAndRules() {
1067 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1068 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1069 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1070 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1071 RunCommand("IP RULES", {"ip", "rule", "show"});
1072 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1073}
1074
Nandana Dutt5c390032019-03-12 10:52:56 +00001075static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1076 std::chrono::milliseconds timeout,
1077 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001078 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001079 sp<android::IServiceManager> sm = defaultServiceManager();
1080 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001081 Vector<String16> args;
1082 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001083 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1084 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001085 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001086 std::string path(title);
1087 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001088 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001089 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001090 if (status == OK) {
1091 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1092 std::chrono::duration<double> elapsed_seconds;
1093 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1094 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001095 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1096 bool dump_complete = (status == OK);
1097 dumpsys.stopDumpThread(dump_complete);
1098 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001099
1100 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1101 std::chrono::steady_clock::now() - start);
1102 if (elapsed_duration > timeout) {
1103 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1104 elapsed_duration.count());
1105 break;
1106 }
1107 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001108 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001109}
1110
Vishnu Nair64afc022018-02-01 15:29:34 -08001111static void RunDumpsysText(const std::string& title, int priority,
1112 std::chrono::milliseconds timeout,
1113 std::chrono::milliseconds service_timeout) {
1114 DurationReporter duration_reporter(title);
1115 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1116 fsync(STDOUT_FILENO);
1117 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1118}
1119
1120/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001121static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1122 std::chrono::milliseconds timeout,
1123 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001124 DurationReporter duration_reporter(title);
1125 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1126 fsync(STDOUT_FILENO);
1127 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1128 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001129
1130 RETURN_IF_USER_DENIED_CONSENT();
1131
1132 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1133 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001134}
1135
Nandana Dutt5c390032019-03-12 10:52:56 +00001136static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1137 std::chrono::milliseconds timeout,
1138 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001139 if (!ds.IsZipping()) {
1140 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001141 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001142 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001143 sp<android::IServiceManager> sm = defaultServiceManager();
1144 Dumpsys dumpsys(sm.get());
1145 Vector<String16> args;
1146 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1147 DurationReporter duration_reporter(title);
1148
1149 auto start = std::chrono::steady_clock::now();
1150 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1151 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001152 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001153 std::string path(kProtoPath);
1154 path.append(String8(service).c_str());
1155 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1156 path.append("_CRITICAL");
1157 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1158 path.append("_HIGH");
1159 }
1160 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001161 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001162 if (status == OK) {
1163 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1164 bool dumpTerminated = (status == OK);
1165 dumpsys.stopDumpThread(dumpTerminated);
1166 }
1167 ZipWriter::FileEntry file_entry;
1168 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001169
1170 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1171 std::chrono::steady_clock::now() - start);
1172 if (elapsed_duration > timeout) {
1173 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1174 elapsed_duration.count());
1175 break;
1176 }
1177 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001178 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001179}
1180
Nandana Dutta7db6342018-11-21 14:53:34 +00001181// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001182static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001183 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1184 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001185
1186 RETURN_IF_USER_DENIED_CONSENT();
1187
1188 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1189 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001190}
1191
1192// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001193static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001194 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1195 // high priority. Reduce timeout once they are able to dump in a shorter time or
1196 // moved to a parallel task.
1197 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1198 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001199
1200 RETURN_IF_USER_DENIED_CONSENT();
1201
1202 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1203 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001204}
1205
1206// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001207static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001208 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001209
1210 RETURN_IF_USER_DENIED_CONSENT();
1211
1212 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1213 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001214}
1215
Steven Moreland44cd9482018-01-04 16:24:13 -08001216static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001217 if (!ds.IsZipping()) {
1218 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1219 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1220 return;
1221 }
1222 DurationReporter duration_reporter("DUMP HALS");
1223 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001224 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001225
Steven Moreland44cd9482018-01-04 16:24:13 -08001226 using android::hidl::manager::V1_0::IServiceManager;
1227 using android::hardware::defaultServiceManager;
1228
1229 sp<IServiceManager> sm = defaultServiceManager();
1230 if (sm == nullptr) {
1231 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1232 return;
1233 }
1234
1235 auto ret = sm->list([&](const auto& interfaces) {
1236 for (const std::string& interface : interfaces) {
1237 std::string cleanName = interface;
1238 std::replace_if(cleanName.begin(),
1239 cleanName.end(),
1240 [](char c) {
1241 return !isalnum(c) &&
1242 std::string("@-_:.").find(c) == std::string::npos;
1243 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001244 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001245
1246 {
1247 auto fd = android::base::unique_fd(
1248 TEMP_FAILURE_RETRY(open(path.c_str(),
1249 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1250 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1251 if (fd < 0) {
1252 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1253 continue;
1254 }
1255 RunCommandToFd(fd,
1256 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001257 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001258 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1259
1260 bool empty = 0 == lseek(fd, 0, SEEK_END);
1261 if (!empty) {
1262 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1263 }
1264 }
1265
1266 unlink(path.c_str());
1267 }
1268 });
1269
1270 if (!ret.isOk()) {
1271 MYLOGE("Could not list hals from hwservicemanager.\n");
1272 }
1273}
1274
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001275static void DumpExternalFragmentationInfo() {
1276 struct stat st;
1277 if (stat("/proc/buddyinfo", &st) != 0) {
1278 MYLOGE("Unable to dump external fragmentation info\n");
1279 return;
1280 }
1281
1282 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1283 std::ifstream ifs("/proc/buddyinfo");
1284 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1285 for (std::string line; std::getline(ifs, line);) {
1286 std::smatch match_results;
1287 if (std::regex_match(line, match_results, unusable_index_regex)) {
1288 std::stringstream free_pages(std::string{match_results[3]});
1289 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1290 std::istream_iterator<int>());
1291
1292 int total_free_pages = 0;
1293 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1294 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1295 }
1296
1297 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1298 match_results[2].str().c_str());
1299
1300 int usable_free_pages = total_free_pages;
1301 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1302 auto unusable_index = (total_free_pages - usable_free_pages) /
1303 static_cast<double>(total_free_pages);
1304 printf(" %5.3f", unusable_index);
1305 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1306 }
1307
1308 printf("\n");
1309 }
1310 }
1311 printf("\n");
1312}
1313
Nandana Dutt5c390032019-03-12 10:52:56 +00001314// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1315// via the consent they are shown. Ignores other errors that occur while running various
1316// commands. The consent checking is currently done around long running tasks, which happen to
1317// be distributed fairly evenly throughout the function.
1318static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001319 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001320
Nandana Dutt5c390032019-03-12 10:52:56 +00001321 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1322 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1323 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001324 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001325 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001326 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001327 DumpFile("MEMORY INFO", "/proc/meminfo");
1328 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001329 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001330
1331 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1332
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001333 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1334 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1335 DumpFile("SLAB INFO", "/proc/slabinfo");
1336 DumpFile("ZONEINFO", "/proc/zoneinfo");
1337 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1338 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001339 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001340
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001341 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1342 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001343
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001344 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001345 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001346
1347 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1348 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001349
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001350 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001351
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001352 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001353 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001354 struct stat s;
1355 if (stat("/proc/modules", &s) != 0) {
1356 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1357 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001358 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001359 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001360
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001361 if (__android_logger_property_get_bool(
1362 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1363 DoKernelLogcat();
1364 } else {
1365 do_dmesg();
1366 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001367
Felipe Lemef0292972016-11-22 13:57:05 -08001368 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001369
1370 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1371
Jeff Brown1dc94e32014-09-11 14:15:27 -07001372 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001373 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001374
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001375 /* Dump Bluetooth HCI logs */
1376 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001377
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001378 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001379 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001380 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001381 }
1382
Felipe Lemee184f662016-10-27 10:04:47 -07001383 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001384
Narayan Kamath8f788292017-05-25 13:20:39 +01001385 // NOTE: tombstones are always added as separate entries in the zip archive
1386 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001387 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001388 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001389 if (!tombstones_dumped) {
1390 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001391 }
1392
Jayachandran Ca94c7172017-06-10 15:08:12 -07001393 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001394
Chenbo Feng276a3b62018-08-07 11:44:49 -07001395 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1396
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001397 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001398
Jayachandran Ca94c7172017-06-10 15:08:12 -07001399 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001400
1401 dump_route_tables();
1402
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001403 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1404 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1405 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001406
Nandana Dutt5c390032019-03-12 10:52:56 +00001407 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001408
Elliott Hughes23ccc622017-02-28 10:14:22 -08001409 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001410
Jin Qianf334d662017-10-10 14:41:37 -07001411 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001412
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001413 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001414
Colin Crossf45fa6b2012-03-26 12:38:26 -07001415 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001416 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1417 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1418
1419 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1420 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1421 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1422 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1423 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001424
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001425 /* Add window and surface trace files. */
1426 if (!PropertiesHelper::IsUserBuild()) {
1427 ds.AddDir(WMTRACE_DATA_DIR, false);
1428 }
1429
Nandana Dutt5c390032019-03-12 10:52:56 +00001430 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001431
Steven Moreland7440ddb2016-12-15 16:13:39 -08001432 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001433 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1434 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001435 // su does not exist on user builds, so try running without it.
1436 // This way any implementations of vril-dump that do not require
1437 // root can run on user builds.
1438 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001439 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001440 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001441 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001442 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001443 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001444 }
1445
Felipe Lemed8b94e52016-12-08 10:21:44 -08001446 printf("========================================================\n");
1447 printf("== Android Framework Services\n");
1448 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001449
Nandana Dutt5c390032019-03-12 10:52:56 +00001450 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001451
Felipe Lemed8b94e52016-12-08 10:21:44 -08001452 printf("========================================================\n");
1453 printf("== Checkins\n");
1454 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001455
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001456 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001457
1458 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1459
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001460 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1461 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1462 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1463 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001464
Felipe Lemed8b94e52016-12-08 10:21:44 -08001465 printf("========================================================\n");
1466 printf("== Running Application Activities\n");
1467 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001468
Makoto Onuki60780982018-04-16 15:34:00 -07001469 // The following dumpsys internally collects output from running apps, so it can take a long
1470 // time. So let's extend the timeout.
1471
1472 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1473
1474 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001475
Felipe Lemed8b94e52016-12-08 10:21:44 -08001476 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001477 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001478 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001479
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001480 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001481 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001482
Felipe Lemed8b94e52016-12-08 10:21:44 -08001483 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001484 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001485 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001486
Makoto Onuki60780982018-04-16 15:34:00 -07001487 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1488 DUMPSYS_COMPONENTS_OPTIONS);
1489
1490 printf("========================================================\n");
1491 printf("== Running Application Providers (platform)\n");
1492 printf("========================================================\n");
1493
1494 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1495 DUMPSYS_COMPONENTS_OPTIONS);
1496
1497 printf("========================================================\n");
1498 printf("== Running Application Providers (non-platform)\n");
1499 printf("========================================================\n");
1500
1501 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1502 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001503
Adrian Roos8b397ab2017-04-04 16:35:44 -07001504 printf("========================================================\n");
1505 printf("== Dropbox crashes\n");
1506 printf("========================================================\n");
1507
1508 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1509 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1510
Felipe Lemed8b94e52016-12-08 10:21:44 -08001511 printf("========================================================\n");
1512 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1513 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1514 printf("========================================================\n");
1515 printf("== dumpstate: done (id %d)\n", ds.id_);
1516 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001517
1518 printf("========================================================\n");
1519 printf("== Obtaining statsd metadata\n");
1520 printf("========================================================\n");
1521 // This differs from the usual dumpsys stats, which is the stats report data.
1522 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001523
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001524 // Add linker configuration directory
1525 ds.AddDir(LINKERCONFIG_DIR, true);
1526
Mike Ma5c267872019-08-21 11:31:34 -07001527 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1528
Nandana Dutt5c390032019-03-12 10:52:56 +00001529 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001530}
1531
Nandana Dutt5c390032019-03-12 10:52:56 +00001532/*
1533 * Dumps state for the default case; drops root after it's no longer necessary.
1534 *
1535 * Returns RunStatus::OK if everything went fine.
1536 * Returns RunStatus::ERROR if there was an error.
1537 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1538 * with the caller.
1539 */
1540static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001541 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001542 // keep the system stats as close to its initial state as possible.
Nandana Dutt5c390032019-03-12 10:52:56 +00001543 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001544
Nandana Duttdb379fa2019-10-09 16:54:41 +01001545 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1546 // buffer.
1547 DoLogcat();
1548 // Capture timestamp after first logcat to use in next logcat
1549 time_t logcat_ts = time(nullptr);
1550
Nandana Dutt4be45d12018-09-26 15:04:23 +01001551 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001552 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001553
1554 /* Run some operations that require root. */
1555 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1556 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1557
1558 ds.AddDir(RECOVERY_DIR, true);
1559 ds.AddDir(RECOVERY_DATA_DIR, true);
1560 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1561 ds.AddDir(LOGPERSIST_DATA_DIR, false);
Yifan Hong0efa7972020-02-03 16:45:02 -08001562 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001563 if (!PropertiesHelper::IsUserBuild()) {
1564 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1565 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1566 }
1567 add_mountinfo();
1568 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001569 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001570 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001571
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001572 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001573 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1574
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001575 // Dump IPsec stats. No keys are exposed here.
1576 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1577
Nandana Dutt4be45d12018-09-26 15:04:23 +01001578 // Run ss as root so we can see socket marks.
1579 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1580
1581 // Run iotop as root to show top 100 IO threads
1582 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1583
Erick Reyese68df822019-02-11 14:46:36 -08001584 // Gather shared memory buffer info if the product implements it
1585 struct stat st;
1586 if (!stat("/product/bin/dmabuf_dump", &st)) {
1587 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1588 }
1589
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001590 DumpFile("PSI cpu", "/proc/pressure/cpu");
1591 DumpFile("PSI memory", "/proc/pressure/memory");
1592 DumpFile("PSI io", "/proc/pressure/io");
1593
Nandana Dutt4be45d12018-09-26 15:04:23 +01001594 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001595 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001596 }
1597
Nandana Dutt5c390032019-03-12 10:52:56 +00001598 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001599 Dumpstate::RunStatus status = dumpstate();
1600 // Capture logcat since the last time we did it.
1601 DoSystemLogcat(logcat_ts);
1602 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001603}
1604
mukesh agrawal253dad42018-01-23 21:59:59 -08001605// This method collects common dumpsys for telephony and wifi
1606static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001607 DumpIpTablesAsRoot();
1608
Jayachandran C69968272019-07-08 09:46:05 -07001609 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1610
Jayachandran Ca94c7172017-06-10 15:08:12 -07001611 if (!DropRootUser()) {
1612 return;
1613 }
1614
1615 do_dmesg();
1616 DoLogcat();
1617 DumpPacketStats();
1618 DoKmsg();
1619 DumpIpAddrAndRules();
1620 dump_route_tables();
Jayachandran C69968272019-07-08 09:46:05 -07001621 DumpHals();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001622
1623 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1624 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001625}
1626
1627// This method collects dumpsys for telephony debugging only
1628static void DumpstateTelephonyOnly() {
1629 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001630 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001631
1632 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001633
1634 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1635
1636 printf("========================================================\n");
1637 printf("== Android Framework Services\n");
1638 printf("========================================================\n");
1639
Vishnu Nair652cc802017-11-30 15:18:30 -08001640 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1641 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001642 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1643 SEC_TO_MSEC(10));
1644 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001645 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1646 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001647 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1648 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001649 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1650 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001651
1652 printf("========================================================\n");
1653 printf("== Running Application Services\n");
1654 printf("========================================================\n");
1655
1656 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1657
1658 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001659 printf("== Running Application Services (non-platform)\n");
1660 printf("========================================================\n");
1661
1662 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1663 DUMPSYS_COMPONENTS_OPTIONS);
1664
1665 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001666 printf("== Checkins\n");
1667 printf("========================================================\n");
1668
1669 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1670
1671 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001672 printf("== dumpstate: done (id %d)\n", ds.id_);
1673 printf("========================================================\n");
1674}
1675
mukesh agrawal253dad42018-01-23 21:59:59 -08001676// This method collects dumpsys for wifi debugging only
1677static void DumpstateWifiOnly() {
1678 DurationReporter duration_reporter("DUMPSTATE");
1679
1680 DumpstateRadioCommon();
1681
1682 printf("========================================================\n");
1683 printf("== Android Framework Services\n");
1684 printf("========================================================\n");
1685
1686 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1687 SEC_TO_MSEC(10));
1688 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1689 SEC_TO_MSEC(10));
1690
1691 printf("========================================================\n");
1692 printf("== dumpstate: done (id %d)\n", ds.id_);
1693 printf("========================================================\n");
1694}
1695
Nandana Duttcf419a72019-03-14 10:40:17 +00001696Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001697 DurationReporter duration_reporter("DUMP TRACES");
1698
1699 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1700 const size_t buf_size = temp_file_pattern.length() + 1;
1701 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1702 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1703
1704 // Create a new, empty file to receive all trace dumps.
1705 //
1706 // TODO: This can be simplified once we remove support for the old style
1707 // dumps. We can have a file descriptor passed in to dump_traces instead
1708 // of creating a file, closing it and then reopening it again.
1709 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1710 if (fd < 0) {
1711 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001712 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001713 }
1714
1715 // Nobody should have access to this temporary file except dumpstate, but we
1716 // temporarily grant 'read' to 'others' here because this file is created
1717 // when tombstoned is still running as root, but dumped after dropping. This
1718 // can go away once support for old style dumping has.
1719 const int chmod_ret = fchmod(fd, 0666);
1720 if (chmod_ret < 0) {
1721 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001722 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001723 }
1724
1725 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1726 if (proc.get() == nullptr) {
1727 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001728 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001729 }
1730
1731 // Number of times process dumping has timed out. If we encounter too many
1732 // failures, we'll give up.
1733 int timeout_failures = 0;
1734 bool dalvik_found = false;
1735
1736 const std::set<int> hal_pids = get_interesting_hal_pids();
1737
1738 struct dirent* d;
1739 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001740 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001741 int pid = atoi(d->d_name);
1742 if (pid <= 0) {
1743 continue;
1744 }
1745
1746 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1747 std::string exe;
1748 if (!android::base::Readlink(link_name, &exe)) {
1749 continue;
1750 }
1751
1752 bool is_java_process;
1753 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1754 // Don't bother dumping backtraces for the zygote.
1755 if (IsZygote(pid)) {
1756 continue;
1757 }
1758
1759 dalvik_found = true;
1760 is_java_process = true;
1761 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1762 is_java_process = false;
1763 } else {
1764 // Probably a native process we don't care about, continue.
1765 continue;
1766 }
1767
1768 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1769 if (timeout_failures == 3) {
1770 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1771 break;
1772 }
1773
1774 const uint64_t start = Nanotime();
1775 const int ret = dump_backtrace_to_file_timeout(
1776 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1777 is_java_process ? 5 : 20, fd);
1778
1779 if (ret == -1) {
1780 // For consistency, the header and footer to this message match those
1781 // dumped by debuggerd in the success case.
1782 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1783 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1784 dprintf(fd, "---- end %d ----", pid);
1785 timeout_failures++;
1786 continue;
1787 }
1788
1789 // We've successfully dumped stack traces, reset the failure count
1790 // and write a summary of the elapsed time to the file and continue with the
1791 // next process.
1792 timeout_failures = 0;
1793
1794 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1795 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1796 }
1797
1798 if (!dalvik_found) {
1799 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1800 }
1801
Nandana Duttcf419a72019-03-14 10:40:17 +00001802 *path = file_name_buf.release();
1803 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001804}
1805
Felipe Leme6f674ae2016-11-18 17:10:33 -08001806void Dumpstate::DumpstateBoard() {
1807 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001808 printf("========================================================\n");
1809 printf("== Board\n");
1810 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001811
Felipe Leme6f674ae2016-11-18 17:10:33 -08001812 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001813 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001814 return;
1815 }
1816
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001817 std::vector<std::string> paths;
1818 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001819 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001820 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1821 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001822 remover.emplace_back(android::base::make_scope_guard(
1823 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001824 }
Jie Song9fbfad02017-06-20 16:29:42 -07001825
Wei Wang587eac92018-04-05 12:17:20 -07001826 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1827 if (dumpstate_device == nullptr) {
1828 MYLOGE("No IDumpstateDevice implementation\n");
1829 return;
1830 }
1831
1832 using ScopedNativeHandle =
1833 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1834 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1835 [](native_handle_t* handle) {
1836 native_handle_close(handle);
1837 native_handle_delete(handle);
1838 });
1839 if (handle == nullptr) {
1840 MYLOGE("Could not create native_handle\n");
1841 return;
1842 }
1843
Nandana Dutt5c390032019-03-12 10:52:56 +00001844 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001845 for (size_t i = 0; i < paths.size(); i++) {
1846 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1847
1848 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1849 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1850 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1851 if (fd < 0) {
1852 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1853 return;
1854 }
1855 handle.get()->data[i] = fd.release();
1856 }
1857
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001858 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001859 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1860 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1861 // and grab whatever dumped
1862 std::packaged_task<bool()>
1863 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001864 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1865 if (!status.isOk()) {
1866 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001867 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001868 }
Wei Wang587eac92018-04-05 12:17:20 -07001869 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001870 });
Wei Wang587eac92018-04-05 12:17:20 -07001871
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001872 auto result = dumpstate_task.get_future();
1873 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001874
1875 constexpr size_t timeout_sec = 30;
1876 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1877 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1878 if (!android::base::SetProperty("ctl.interface_restart",
1879 android::base::StringPrintf("%s/default",
1880 IDumpstateDevice::descriptor))) {
1881 MYLOGE("Couldn't restart dumpstate HAL\n");
1882 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001883 }
Wei Wang587eac92018-04-05 12:17:20 -07001884 // Wait some time for init to kill dumpstate vendor HAL
1885 constexpr size_t killing_timeout_sec = 10;
1886 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1887 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1888 "there might be racing in content\n", killing_timeout_sec);
1889 }
1890
1891 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1892 for (size_t i = 0; i < paths.size(); i++) {
1893 struct stat s;
1894 if (fstat(handle.get()->data[i], &s) == -1) {
1895 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1896 strerror(errno));
1897 file_sizes[i] = -1;
1898 continue;
1899 }
1900 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001901 }
1902
1903 for (size_t i = 0; i < paths.size(); i++) {
1904 if (file_sizes[i] == -1) {
1905 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001906 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001907 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001908 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001909 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001910 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001911 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001912 }
1913
Felipe Lemed8b94e52016-12-08 10:21:44 -08001914 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001915}
1916
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001917static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001918 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001919 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001920 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1921 " -h: display this help message\n"
1922 " -b: play sound file instead of vibrate, at beginning of job\n"
1923 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001924 " -d: append date to filename\n"
1925 " -p: capture screenshot to filename.png\n"
1926 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001927 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001928 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001929 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001930 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001931 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001932 "progress (requires -B)\n"
1933 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001934 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001935 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001936 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001937}
1938
Wei Liuf87959e2016-08-26 14:51:42 -07001939static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001940 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001941}
1942
Felipe Leme1d486fe2016-10-14 18:06:47 -07001943bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001944 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001945 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001946 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001947 // Final timestamp
1948 char date[80];
1949 time_t the_real_now_please_stand_up = time(nullptr);
1950 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001951 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001952 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001953
Felipe Leme9a523ae2016-10-20 15:10:33 -07001954 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001955 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001956 return false;
1957 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001958 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001959 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001960 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001961 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001962
Felipe Leme0f3fb202016-06-10 17:10:53 -07001963 // Add log file (which contains stderr output) to zip...
1964 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001965 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001966 MYLOGE("Failed to add dumpstate log to .zip file\n");
1967 return false;
1968 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001969 // TODO: Should truncate the existing file.
1970 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001971 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1972 return false;
1973 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001974 fprintf(stderr, "\n");
1975
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001976 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001977 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001978 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001979 return false;
1980 }
1981
Felipe Leme1d486fe2016-10-14 18:06:47 -07001982 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1983 ds.zip_file.reset(nullptr);
1984
Felipe Lemee9d2c542016-11-15 11:48:26 -08001985 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001986 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001987
Felipe Leme1e9edc62015-12-21 16:02:13 -08001988 return true;
1989}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001990
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07001991static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07001992 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
1993 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07001994 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001995 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001996 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001997 }
1998
1999 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002000 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002001
2002 std::vector<uint8_t> buffer(65536);
2003 while (1) {
2004 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
2005 if (bytes_read == 0) {
2006 break;
2007 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002008 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002009 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002010 }
2011
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002012 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002013 }
2014
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002015 uint8_t hash[SHA256_DIGEST_LENGTH];
2016 SHA256_Final(hash, &ctx);
2017
2018 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
2019 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00002020 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002021 }
2022 hash_buffer[sizeof(hash_buffer) - 1] = 0;
2023 return std::string(hash_buffer);
2024}
2025
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002026static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2027 // clang-format off
2028 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2029 "--receiver-foreground", "--receiver-include-background", "-a", action};
2030 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002031
2032 am.insert(am.end(), args.begin(), args.end());
2033
Felipe Leme8d2410e2017-02-08 09:46:08 -08002034 RunCommand("", am,
2035 CommandOptions::WithTimeout(20)
2036 .Log("Sending broadcast: '%s'\n")
2037 .Always()
2038 .DropRoot()
2039 .RedirectStderr()
2040 .Build());
2041}
2042
Felipe Leme35b8cf12017-02-10 15:47:29 -08002043static void Vibrate(int duration_ms) {
2044 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002045 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002046 CommandOptions::WithTimeout(10)
2047 .Log("Vibrate: '%s'\n")
2048 .Always()
2049 .Build());
2050 // clang-format on
2051}
2052
Nandana Dutt979388e2018-11-30 16:48:55 +00002053static void MaybeResolveSymlink(std::string* path) {
2054 std::string resolved_path;
2055 if (android::base::Readlink(*path, &resolved_path)) {
2056 *path = resolved_path;
2057 }
2058}
2059
Nandana Dutt4be45d12018-09-26 15:04:23 +01002060/*
2061 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2062 * if we are writing zip files and adds the version file.
2063 */
2064static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002065 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2066
Nandana Dutt4be45d12018-09-26 15:04:23 +01002067 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2068 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002069 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002070 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002071 char date[80];
2072 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2073 ds.name_ = date;
2074 } else {
2075 ds.name_ = "undated";
2076 }
2077
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002078 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002079 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002080 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002081 ds.base_name_ += "-wifi";
2082 }
2083
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002084 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002085 ds.screenshot_path_ = ds.GetPath(".png");
2086 }
2087 ds.tmp_path_ = ds.GetPath(".tmp");
2088 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2089
Nandana Dutt54dbd672019-01-11 12:58:05 +00002090 std::string destination = ds.options_->bugreport_fd.get() != -1
2091 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002092 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002093 MYLOGD(
2094 "Bugreport dir: %s\n"
2095 "Base name: %s\n"
2096 "Suffix: %s\n"
2097 "Log path: %s\n"
2098 "Temporary path: %s\n"
2099 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002100 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2101 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002102
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002103 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002104 ds.path_ = ds.GetPath(".zip");
2105 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2106 create_parent_dirs(ds.path_.c_str());
2107 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2108 if (ds.zip_file == nullptr) {
2109 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2110 } else {
2111 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2112 }
2113 ds.AddTextZipEntry("version.txt", ds.version_);
2114 }
2115}
2116
2117/*
2118 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
2119 * printing zipped file status, etc.
2120 */
2121static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002122 /* check if user changed the suffix using system properties */
2123 std::string name =
2124 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
2125 bool change_suffix = false;
2126 if (!name.empty()) {
2127 /* must whitelist which characters are allowed, otherwise it could cross directories */
2128 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
2129 if (std::regex_match(name.c_str(), valid_regex)) {
2130 change_suffix = true;
2131 } else {
2132 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
2133 }
2134 }
2135 if (change_suffix) {
2136 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
2137 ds.name_ = name;
2138 if (!ds.screenshot_path_.empty()) {
2139 std::string new_screenshot_path = ds.GetPath(".png");
2140 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
2141 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
2142 new_screenshot_path.c_str(), strerror(errno));
2143 } else {
2144 ds.screenshot_path_ = new_screenshot_path;
2145 }
2146 }
2147 }
2148
2149 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002150 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002151 if (!ds.FinishZipFile()) {
2152 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2153 do_text_file = true;
2154 } else {
2155 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002156 // If the user has changed the suffix, we need to change the zip file name.
2157 std::string new_path = ds.GetPath(".zip");
2158 if (ds.path_ != new_path) {
2159 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2160 if (rename(ds.path_.c_str(), new_path.c_str())) {
2161 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2162 strerror(errno));
2163 } else {
2164 ds.path_ = new_path;
2165 }
2166 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002167 }
2168 }
2169 if (do_text_file) {
2170 ds.path_ = ds.GetPath(".txt");
2171 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2172 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2173 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2174 ds.path_.clear();
2175 }
2176 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002177 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002178 if (do_text_file) {
2179 dprintf(ds.control_socket_fd_,
2180 "FAIL:could not create zip file, check %s "
2181 "for more details\n",
2182 ds.log_path_.c_str());
2183 } else {
2184 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2185 }
2186 }
2187}
2188
2189/* Broadcasts that we are done with the bugreport */
2190static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002191 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002192 if (!ds.path_.empty()) {
2193 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002194 // clang-format off
2195
2196 std::vector<std::string> am_args = {
2197 "--receiver-permission", "android.permission.DUMP",
2198 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2199 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2200 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002201 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002202 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2203 };
2204 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002205 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002206 am_args.push_back("--es");
2207 am_args.push_back("android.intent.extra.SCREENSHOT");
2208 am_args.push_back(ds.screenshot_path_);
2209 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002210 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002211 am_args.push_back("--es");
2212 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002213 am_args.push_back(ds.options_->notification_title);
2214 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002215 am_args.push_back("--es");
2216 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002217 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002218 }
2219 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002220 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002221 am_args.push_back("--es");
2222 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002223 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002224 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2225 } else {
2226 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2227 }
2228 } else {
2229 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2230 }
2231}
2232
Nandana Dutt58d72e22018-11-16 10:30:48 +00002233static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2234 switch (mode) {
2235 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2236 return "BUGREPORT_FULL";
2237 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2238 return "BUGREPORT_INTERACTIVE";
2239 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2240 return "BUGREPORT_REMOTE";
2241 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2242 return "BUGREPORT_WEAR";
2243 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2244 return "BUGREPORT_TELEPHONY";
2245 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2246 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002247 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2248 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002249 }
2250}
2251
2252static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002253 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002254 switch (mode) {
2255 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2256 options->do_broadcast = true;
2257 options->do_fb = true;
2258 break;
2259 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002260 // Currently, the dumpstate binder is only used by Shell to update progress.
2261 options->do_start_service = true;
2262 options->do_progress_updates = true;
2263 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002264 options->do_broadcast = true;
2265 break;
2266 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002267 options->do_vibrate = false;
2268 options->is_remote_mode = true;
2269 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002270 options->do_broadcast = true;
2271 break;
2272 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002273 options->do_start_service = true;
2274 options->do_progress_updates = true;
2275 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002276 options->do_fb = true;
2277 options->do_broadcast = true;
2278 break;
2279 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002280 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002281 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002282 options->do_broadcast = true;
2283 break;
2284 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002285 options->wifi_only = true;
2286 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002287 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002288 options->do_broadcast = true;
2289 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002290 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2291 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002292 }
2293}
2294
2295static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002296 // If the system property is not set, it's assumed to be a default bugreport.
2297 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002298
2299 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2300 if (!extra_options.empty()) {
2301 // Framework uses a system property to override some command-line args.
2302 // Currently, it contains the type of the requested bugreport.
2303 if (extra_options == "bugreportplus") {
2304 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002305 } else if (extra_options == "bugreportfull") {
2306 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002307 } else if (extra_options == "bugreportremote") {
2308 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2309 } else if (extra_options == "bugreportwear") {
2310 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2311 } else if (extra_options == "bugreporttelephony") {
2312 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2313 } else if (extra_options == "bugreportwifi") {
2314 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002315 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002316 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002317 }
2318 // Reset the property
2319 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2320 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002321 return mode;
2322}
2323
2324// TODO: Move away from system properties when we have options passed via binder calls.
2325/* Sets runtime options from the system properties and then clears those properties. */
2326static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2327 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2328 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002329
2330 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2331 if (!options->notification_title.empty()) {
2332 // Reset the property
2333 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2334
Nandana Duttdd8cca32018-11-14 10:10:29 +00002335 options->notification_description =
2336 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002337 if (!options->notification_description.empty()) {
2338 // Reset the property
2339 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2340 }
2341 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2342 options->notification_description.c_str());
2343 }
2344}
2345
Nandana Dutt58d72e22018-11-16 10:30:48 +00002346static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2347 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2348 MYLOGI("do_add_date: %d\n", options.do_add_date);
2349 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2350 MYLOGI("use_socket: %d\n", options.use_socket);
2351 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2352 MYLOGI("do_fb: %d\n", options.do_fb);
2353 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2354 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2355 MYLOGI("show_header_only: %d\n", options.show_header_only);
2356 MYLOGI("do_start_service: %d\n", options.do_start_service);
2357 MYLOGI("telephony_only: %d\n", options.telephony_only);
2358 MYLOGI("wifi_only: %d\n", options.wifi_only);
2359 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002360 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002361 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2362 MYLOGI("args: %s\n", options.args.c_str());
2363 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2364 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2365}
2366
Nandana Dutt54dbd672019-01-11 12:58:05 +00002367void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2368 const android::base::unique_fd& bugreport_fd_in,
2369 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002370 // In the new API world, date is always added; output is always a zip file.
2371 // TODO(111441001): remove these options once they are obsolete.
2372 do_add_date = true;
2373 do_zip_file = true;
2374
Nandana Dutt54dbd672019-01-11 12:58:05 +00002375 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2376 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2377 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002378
2379 extra_options = ModeToString(bugreport_mode);
2380 SetOptionsFromMode(bugreport_mode, this);
2381}
2382
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002383Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2384 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002385 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002386 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002387 switch (c) {
2388 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002389 case 'd': do_add_date = true; break;
2390 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002391 // o=use_outfile not supported anymore.
2392 // TODO(b/111441001): Remove when all callers have migrated.
2393 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002394 case 's': use_socket = true; break;
2395 case 'S': use_control_socket = true; break;
2396 case 'v': show_header_only = true; break;
2397 case 'q': do_vibrate = false; break;
2398 case 'p': do_fb = true; break;
2399 case 'P': do_progress_updates = true; break;
2400 case 'R': is_remote_mode = true; break;
2401 case 'B': do_broadcast = true; break;
2402 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002403 case 'w':
2404 // This was already processed
2405 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002406 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002407 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002408 break;
2409 default:
2410 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002411 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002412 break;
2413 // clang-format on
2414 }
2415 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002416
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002417 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002418 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002419 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002420 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002421 }
2422 }
2423
2424 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2425 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002426
2427 SetOptionsFromProperties(this);
2428 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002429}
2430
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002431bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002432 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002433 return false;
2434 }
2435
Nandana Dutt9a76d202019-01-21 15:56:48 +00002436 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002437 return false;
2438 }
2439
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002440 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002441 return false;
2442 }
2443
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002444 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002445 return false;
2446 }
2447
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002448 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002449 return false;
2450 }
2451 return true;
2452}
2453
Nandana Dutt197661d2018-11-16 16:40:21 +00002454void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2455 options_ = std::move(options);
2456}
2457
Nandana Duttd2f5f082019-01-18 17:13:52 +00002458Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2459 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002460 if (listener_ != nullptr) {
2461 switch (status) {
2462 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002463 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002464 break;
2465 case Dumpstate::RunStatus::HELP:
2466 break;
2467 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002468 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002469 break;
2470 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002471 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2472 break;
2473 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2474 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2475 break;
2476 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2477 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002478 break;
2479 }
2480 }
2481 return status;
2482}
2483
Nandana Dutt979388e2018-11-30 16:48:55 +00002484/*
2485 * Dumps relevant information to a bugreport based on the given options.
2486 *
2487 * The bugreport can be dumped to a file or streamed to a socket.
2488 *
2489 * How dumping to file works:
2490 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2491 * stderr is redirected a log file.
2492 *
2493 * The temporary bugreport is then populated via printfs, dumping contents of files and
2494 * output of commands to stdout.
2495 *
2496 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2497 * text file.
2498 *
2499 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2500 * gets added to the archive.
2501 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002502 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2503 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002504 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002505Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2506 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002507 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002508 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002509 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002510 return RunStatus::INVALID_INPUT;
2511 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002512 /* set as high priority, and protect from OOM killer */
2513 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002514
Felipe Lemed071c682016-10-20 16:48:00 -07002515 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002516 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002517 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002518 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002519 } else {
2520 /* fallback to kernels <= 2.6.35 */
2521 oom_adj = fopen("/proc/self/oom_adj", "we");
2522 if (oom_adj) {
2523 fputs("-17", oom_adj);
2524 fclose(oom_adj);
2525 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002526 }
2527
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002528 if (version_ == VERSION_DEFAULT) {
2529 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002530 }
2531
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002532 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002533 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002534 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002535 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002536 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002537 }
2538
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002539 if (options_->show_header_only) {
2540 PrintHeader();
2541 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002542 }
2543
Nandana Duttd2f5f082019-01-18 17:13:52 +00002544 if (options_->bugreport_fd.get() != -1) {
2545 // If the output needs to be copied over to the caller's fd, get user consent.
2546 android::String16 package(calling_package.c_str());
2547 CheckUserConsent(calling_uid, package);
2548 }
2549
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002550 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002551 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002552
2553 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002554 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002555 is_redirecting
2556 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2557 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002558 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002559
Felipe Lemed071c682016-10-20 16:48:00 -07002560 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002561 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002562 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002563 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2564
2565 MYLOGI("begin\n");
2566
Sahana Raof35ed432019-07-12 10:47:52 +01002567 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2568 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2569 } else {
2570 // Wake lock will be released automatically on process death
2571 MYLOGD("Wake lock acquired.\n");
2572 }
2573
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002574 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002575
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002576 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002577 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002578 MYLOGI("Starting 'dumpstate' service\n");
2579 android::status_t ret;
2580 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2581 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2582 }
2583 }
2584
Felipe Lemef0292972016-11-22 13:57:05 -08002585 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002586 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2587 }
2588
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002589 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2590 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002591
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002592 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002593
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002594 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002595
Christopher Ferrised9354f2014-10-01 17:35:01 -07002596 // If we are going to use a socket, do it as early as possible
2597 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002598 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002599 if (!redirect_to_socket(stdout, "dumpstate")) {
2600 return ERROR;
2601 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002602 }
2603
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002604 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002605 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002606 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002607 if (control_socket_fd_ == -1) {
2608 return ERROR;
2609 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002610 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002611 }
2612
Felipe Leme71bbfc52015-11-23 14:14:51 -08002613 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002614 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002615
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002616 if (options_->do_progress_updates) {
2617 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002618 // clang-format off
2619 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002620 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002621 "--es", "android.intent.extra.NAME", name_,
2622 "--ei", "android.intent.extra.ID", std::to_string(id_),
2623 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2624 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002625 };
2626 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002627 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002628 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002629 if (options_->use_control_socket) {
2630 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002631 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002632 }
2633 }
2634
Nick Kralevichf3599b32016-01-25 15:05:16 -08002635 /* read /proc/cmdline before dropping root */
2636 FILE *cmdline = fopen("/proc/cmdline", "re");
2637 if (cmdline) {
2638 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2639 fclose(cmdline);
2640 }
2641
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002642 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002643 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002644 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002645
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002646 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002647 MYLOGI("taking early screenshot\n");
2648 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002649 }
2650
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002651 if (options_->do_zip_file && zip_file != nullptr) {
2652 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2653 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002654 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002655 }
2656 }
2657
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002658 int dup_stdout_fd;
2659 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002660 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002661 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002662 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002663 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2664 return ERROR;
2665 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002666 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2667 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2668 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002669 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002670
2671 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2672 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002673 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002674 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002675 /* TODO: rather than generating a text file now and zipping it later,
2676 it would be more efficient to redirect stdout to the zip entry
2677 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002678 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2679 return ERROR;
2680 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002681 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002682 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002683 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002684 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002685 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002686
2687 // Don't buffer stdout
2688 setvbuf(stdout, nullptr, _IONBF, 0);
2689
Felipe Leme608385d2016-02-01 10:35:38 -08002690 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2691 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002692 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002693 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002694
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002695 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002696 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002697 DumpstateBoard();
2698 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002699 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002700 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002701 // Dump state for the default case. This also drops root.
Nandana Dutt5c390032019-03-12 10:52:56 +00002702 RunStatus s = DumpstateDefault();
2703 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002704 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002705 HandleUserConsentDenied();
2706 }
2707 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002708 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002709 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002710
Felipe Leme55b42a62015-11-10 17:39:08 -08002711 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002712 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002713 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002714 }
2715
Nandana Duttd2f5f082019-01-18 17:13:52 +00002716 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002717 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002718 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002719 }
2720
Nandana Duttd2f5f082019-01-18 17:13:52 +00002721 // Share the final file with the caller if the user has consented.
2722 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2723 if (options_->bugreport_fd.get() != -1) {
2724 status = CopyBugreportIfUserConsented();
2725 if (status != Dumpstate::RunStatus::OK &&
2726 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2727 // Do an early return if there were errors. We make an exception for consent
2728 // timing out because it's possible the user got distracted. In this case the
2729 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002730 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002731 return status;
2732 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002733 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002734 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2735 options_->screenshot_fd.get());
2736 if (copy_succeeded) {
2737 android::os::UnlinkAndLogOnError(screenshot_path_);
2738 }
2739 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002740 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2741 MYLOGI(
2742 "Did not receive user consent yet."
2743 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002744 const String16 incidentcompanion("incidentcompanion");
2745 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2746 if (ics != nullptr) {
2747 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2748 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2749 consent_callback_.get());
2750 } else {
2751 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2752 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002753 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002754 }
2755
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002756 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002757 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002758 for (int i = 0; i < 3; i++) {
2759 Vibrate(75);
2760 usleep((75 + 50) * 1000);
2761 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002762 }
2763
Jeff Brown1dc94e32014-09-11 14:15:27 -07002764 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002765 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002766 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002767 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002768 }
2769
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002770 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2771 progress_->GetInitialMax());
2772 progress_->Save();
2773 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002774
Felipe Leme107a05f2016-03-08 15:11:15 -08002775 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002776 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002777 }
2778
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002779 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002780 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002781 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002782 }
2783
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002784 tombstone_data_.clear();
2785 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002786
Nandana Duttd2f5f082019-01-18 17:13:52 +00002787 return (consent_callback_ != nullptr &&
2788 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2789 ? USER_CONSENT_TIMED_OUT
2790 : RunStatus::OK;
2791}
2792
2793void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2794 consent_callback_ = new ConsentCallback();
2795 const String16 incidentcompanion("incidentcompanion");
2796 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2797 if (ics != nullptr) {
2798 MYLOGD("Checking user consent via incidentcompanion service\n");
2799 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Joe Onorato1c36d752019-03-17 18:26:43 -07002800 calling_uid, calling_package, String16(), String16(),
2801 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002802 } else {
2803 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2804 }
2805}
2806
Nandana Dutt5c390032019-03-12 10:52:56 +00002807bool Dumpstate::IsUserConsentDenied() const {
2808 return ds.consent_callback_ != nullptr &&
2809 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2810}
2811
Nandana Duttd2f5f082019-01-18 17:13:52 +00002812void Dumpstate::CleanupFiles() {
2813 android::os::UnlinkAndLogOnError(tmp_path_);
2814 android::os::UnlinkAndLogOnError(screenshot_path_);
2815 android::os::UnlinkAndLogOnError(path_);
2816}
2817
2818Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2819 MYLOGD("User denied consent; deleting files and returning\n");
2820 CleanupFiles();
2821 return USER_CONSENT_DENIED;
2822}
2823
2824Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2825 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2826 // user consent.
2827 UserConsentResult consent_result = consent_callback_->getResult();
2828 if (consent_result == UserConsentResult::UNAVAILABLE) {
2829 // User has not responded yet.
2830 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2831 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2832 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2833 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2834 sleep(delay_seconds);
2835 }
2836 consent_result = consent_callback_->getResult();
2837 }
2838 if (consent_result == UserConsentResult::DENIED) {
2839 // User has explicitly denied sharing with the app. To be safe delete the
2840 // internal bugreport & tmp files.
2841 return HandleUserConsentDenied();
2842 }
2843 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002844 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2845 if (copy_succeeded) {
2846 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002847 }
2848 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2849 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2850 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2851 // Since we do not have user consent to share the bugreport it does not get
2852 // copied over to the calling app but remains in the internal directory from
2853 // where the user can manually pull it.
2854 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2855 }
2856 // Unknown result; must be a programming error.
2857 MYLOGE("Unknown user consent result:%d\n", consent_result);
2858 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002859}
2860
Nandana Duttf02564e2019-02-15 15:24:24 +00002861Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002862 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2863 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2864 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002865 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002866 // When directly running dumpstate binary, the output is not expected to be written
2867 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002868 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002869
2870 // calling_uid and calling_package are for user consent to share the bugreport with
2871 // an app; they are irrelvant here because bugreport is only written to a local
2872 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002873 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002874 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002875 return status;
2876}
2877
2878/* Main entry point for dumpstate binary. */
2879int run_main(int argc, char* argv[]) {
2880 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002881
2882 switch (status) {
2883 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002884 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002885 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002886 ShowUsage();
2887 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002888 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002889 fprintf(stderr, "Invalid combination of args\n");
2890 ShowUsage();
2891 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002892 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002893 FALLTHROUGH_INTENDED;
2894 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2895 FALLTHROUGH_INTENDED;
2896 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002897 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002898 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002899}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002900
2901// TODO(111441001): Default DumpOptions to sensible values.
2902Dumpstate::Dumpstate(const std::string& version)
2903 : pid_(getpid()),
2904 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01002905 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002906 version_(version),
2907 now_(time(nullptr)) {
2908}
2909
2910Dumpstate& Dumpstate::GetInstance() {
2911 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2912 return singleton_;
2913}
2914
Nandana Dutt8d945c02019-08-14 13:30:07 +01002915DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2916 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002917 if (!title_.empty()) {
2918 started_ = Nanotime();
2919 }
2920}
2921
2922DurationReporter::~DurationReporter() {
2923 if (!title_.empty()) {
2924 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002925 if (elapsed >= .5f || verbose_) {
2926 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002927 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002928 if (!logcat_only_) {
2929 // Use "Yoda grammar" to make it easier to grep|sort sections.
2930 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002931 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002932 }
2933}
2934
2935const int32_t Progress::kDefaultMax = 5000;
2936
2937Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2938}
2939
2940Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2941 : Progress(initial_max, growth_factor, "") {
2942 progress_ = progress;
2943}
2944
2945Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2946 : initial_max_(initial_max),
2947 progress_(0),
2948 max_(initial_max),
2949 growth_factor_(growth_factor),
2950 n_runs_(0),
2951 average_max_(0),
2952 path_(path) {
2953 if (!path_.empty()) {
2954 Load();
2955 }
2956}
2957
2958void Progress::Load() {
2959 MYLOGD("Loading stats from %s\n", path_.c_str());
2960 std::string content;
2961 if (!android::base::ReadFileToString(path_, &content)) {
2962 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2963 return;
2964 }
2965 if (content.empty()) {
2966 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2967 return;
2968 }
2969 std::vector<std::string> lines = android::base::Split(content, "\n");
2970
2971 if (lines.size() < 1) {
2972 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2973 (int)lines.size(), max_);
2974 return;
2975 }
2976 char* ptr;
2977 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2978 average_max_ = strtol(ptr, nullptr, 10);
2979 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2980 average_max_ > STATS_MAX_AVERAGE) {
2981 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2982 initial_max_ = Progress::kDefaultMax;
2983 } else {
2984 initial_max_ = average_max_;
2985 }
2986 max_ = initial_max_;
2987
2988 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2989}
2990
2991void Progress::Save() {
2992 int32_t total = n_runs_ * average_max_ + progress_;
2993 int32_t runs = n_runs_ + 1;
2994 int32_t average = floor(((float)total) / runs);
2995 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2996 path_.c_str());
2997 if (path_.empty()) {
2998 return;
2999 }
3000
3001 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3002 if (!android::base::WriteStringToFile(content, path_)) {
3003 MYLOGE("Could not save stats on %s\n", path_.c_str());
3004 }
3005}
3006
3007int32_t Progress::Get() const {
3008 return progress_;
3009}
3010
3011bool Progress::Inc(int32_t delta_sec) {
3012 bool changed = false;
3013 if (delta_sec >= 0) {
3014 progress_ += delta_sec;
3015 if (progress_ > max_) {
3016 int32_t old_max = max_;
3017 max_ = floor((float)progress_ * growth_factor_);
3018 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3019 changed = true;
3020 }
3021 }
3022 return changed;
3023}
3024
3025int32_t Progress::GetMax() const {
3026 return max_;
3027}
3028
3029int32_t Progress::GetInitialMax() const {
3030 return initial_max_;
3031}
3032
3033void Progress::Dump(int fd, const std::string& prefix) const {
3034 const char* pr = prefix.c_str();
3035 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3036 dprintf(fd, "%smax: %d\n", pr, max_);
3037 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3038 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3039 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3040 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3041 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3042}
3043
3044bool Dumpstate::IsZipping() const {
3045 return zip_writer_ != nullptr;
3046}
3047
3048std::string Dumpstate::GetPath(const std::string& suffix) const {
3049 return GetPath(bugreport_internal_dir_, suffix);
3050}
3051
3052std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3053 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3054 name_.c_str(), suffix.c_str());
3055}
3056
3057void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3058 progress_ = std::move(progress);
3059}
3060
3061void for_each_userid(void (*func)(int), const char *header) {
3062 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3063 "for_each_userid(%s)", header);
3064 DurationReporter duration_reporter(title);
3065 if (PropertiesHelper::IsDryRun()) return;
3066
3067 DIR *d;
3068 struct dirent *de;
3069
3070 if (header) printf("\n------ %s ------\n", header);
3071 func(0);
3072
3073 if (!(d = opendir("/data/system/users"))) {
3074 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3075 return;
3076 }
3077
3078 while ((de = readdir(d))) {
3079 int userid;
3080 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3081 continue;
3082 }
3083 func(userid);
3084 }
3085
3086 closedir(d);
3087}
3088
3089static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3090 DIR *d;
3091 struct dirent *de;
3092
3093 if (!(d = opendir("/proc"))) {
3094 printf("Failed to open /proc (%s)\n", strerror(errno));
3095 return;
3096 }
3097
3098 if (header) printf("\n------ %s ------\n", header);
3099 while ((de = readdir(d))) {
3100 if (ds.IsUserConsentDenied()) {
3101 MYLOGE(
3102 "Returning early because user denied consent to share bugreport with calling app.");
3103 closedir(d);
3104 return;
3105 }
3106 int pid;
3107 int fd;
3108 char cmdpath[255];
3109 char cmdline[255];
3110
3111 if (!(pid = atoi(de->d_name))) {
3112 continue;
3113 }
3114
3115 memset(cmdline, 0, sizeof(cmdline));
3116
3117 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3118 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3119 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3120 close(fd);
3121 if (cmdline[0]) {
3122 helper(pid, cmdline, arg);
3123 continue;
3124 }
3125 }
3126
3127 // if no cmdline, a kernel thread has comm
3128 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3129 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3130 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3131 close(fd);
3132 if (cmdline[1]) {
3133 cmdline[0] = '[';
3134 size_t len = strcspn(cmdline, "\f\b\r\n");
3135 cmdline[len] = ']';
3136 cmdline[len+1] = '\0';
3137 }
3138 }
3139 if (!cmdline[0]) {
3140 strcpy(cmdline, "N/A");
3141 }
3142 helper(pid, cmdline, arg);
3143 }
3144
3145 closedir(d);
3146}
3147
3148static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3149 for_each_pid_func *func = (for_each_pid_func*) arg;
3150 func(pid, cmdline);
3151}
3152
3153void for_each_pid(for_each_pid_func func, const char *header) {
3154 std::string title = header == nullptr ? "for_each_pid"
3155 : android::base::StringPrintf("for_each_pid(%s)", header);
3156 DurationReporter duration_reporter(title);
3157 if (PropertiesHelper::IsDryRun()) return;
3158
3159 __for_each_pid(for_each_pid_helper, header, (void *) func);
3160}
3161
3162static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3163 DIR *d;
3164 struct dirent *de;
3165 char taskpath[255];
3166 for_each_tid_func *func = (for_each_tid_func *) arg;
3167
3168 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3169
3170 if (!(d = opendir(taskpath))) {
3171 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3172 return;
3173 }
3174
3175 func(pid, pid, cmdline);
3176
3177 while ((de = readdir(d))) {
3178 if (ds.IsUserConsentDenied()) {
3179 MYLOGE(
3180 "Returning early because user denied consent to share bugreport with calling app.");
3181 closedir(d);
3182 return;
3183 }
3184 int tid;
3185 int fd;
3186 char commpath[255];
3187 char comm[255];
3188
3189 if (!(tid = atoi(de->d_name))) {
3190 continue;
3191 }
3192
3193 if (tid == pid)
3194 continue;
3195
3196 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3197 memset(comm, 0, sizeof(comm));
3198 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3199 strcpy(comm, "N/A");
3200 } else {
3201 char *c;
3202 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3203 close(fd);
3204
3205 c = strrchr(comm, '\n');
3206 if (c) {
3207 *c = '\0';
3208 }
3209 }
3210 func(pid, tid, comm);
3211 }
3212
3213 closedir(d);
3214}
3215
3216void for_each_tid(for_each_tid_func func, const char *header) {
3217 std::string title = header == nullptr ? "for_each_tid"
3218 : android::base::StringPrintf("for_each_tid(%s)", header);
3219 DurationReporter duration_reporter(title);
3220
3221 if (PropertiesHelper::IsDryRun()) return;
3222
3223 __for_each_pid(for_each_tid_helper, header, (void *) func);
3224}
3225
3226void show_wchan(int pid, int tid, const char *name) {
3227 if (PropertiesHelper::IsDryRun()) return;
3228
3229 char path[255];
3230 char buffer[255];
3231 int fd, ret, save_errno;
3232 char name_buffer[255];
3233
3234 memset(buffer, 0, sizeof(buffer));
3235
3236 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3237 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3238 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3239 return;
3240 }
3241
3242 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3243 save_errno = errno;
3244 close(fd);
3245
3246 if (ret < 0) {
3247 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3248 return;
3249 }
3250
3251 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3252 pid == tid ? 0 : 3, "", name);
3253
3254 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3255
3256 return;
3257}
3258
3259// print time in centiseconds
3260static void snprcent(char *buffer, size_t len, size_t spc,
3261 unsigned long long time) {
3262 static long hz; // cache discovered hz
3263
3264 if (hz <= 0) {
3265 hz = sysconf(_SC_CLK_TCK);
3266 if (hz <= 0) {
3267 hz = 1000;
3268 }
3269 }
3270
3271 // convert to centiseconds
3272 time = (time * 100 + (hz / 2)) / hz;
3273
3274 char str[16];
3275
3276 snprintf(str, sizeof(str), " %llu.%02u",
3277 time / 100, (unsigned)(time % 100));
3278 size_t offset = strlen(buffer);
3279 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3280 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3281}
3282
3283// print permille as a percent
3284static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3285 char str[16];
3286
3287 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3288 size_t offset = strlen(buffer);
3289 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3290 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3291}
3292
3293void show_showtime(int pid, const char *name) {
3294 if (PropertiesHelper::IsDryRun()) return;
3295
3296 char path[255];
3297 char buffer[1023];
3298 int fd, ret, save_errno;
3299
3300 memset(buffer, 0, sizeof(buffer));
3301
3302 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3303 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3304 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3305 return;
3306 }
3307
3308 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3309 save_errno = errno;
3310 close(fd);
3311
3312 if (ret < 0) {
3313 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3314 return;
3315 }
3316
3317 // field 14 is utime
3318 // field 15 is stime
3319 // field 42 is iotime
3320 unsigned long long utime = 0, stime = 0, iotime = 0;
3321 if (sscanf(buffer,
3322 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3323 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3324 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3325 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3326 &utime, &stime, &iotime) != 3) {
3327 return;
3328 }
3329
3330 unsigned long long total = utime + stime;
3331 if (!total) {
3332 return;
3333 }
3334
3335 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3336 if (permille > 1000) {
3337 permille = 1000;
3338 }
3339
3340 // try to beautify and stabilize columns at <80 characters
3341 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3342 if ((name[0] != '[') || utime) {
3343 snprcent(buffer, sizeof(buffer), 57, utime);
3344 }
3345 snprcent(buffer, sizeof(buffer), 65, stime);
3346 if ((name[0] != '[') || iotime) {
3347 snprcent(buffer, sizeof(buffer), 73, iotime);
3348 }
3349 if (iotime) {
3350 snprdec(buffer, sizeof(buffer), 79, permille);
3351 }
3352 puts(buffer); // adds a trailing newline
3353
3354 return;
3355}
3356
3357void do_dmesg() {
3358 const char *title = "KERNEL LOG (dmesg)";
3359 DurationReporter duration_reporter(title);
3360 printf("------ %s ------\n", title);
3361
3362 if (PropertiesHelper::IsDryRun()) return;
3363
3364 /* Get size of kernel buffer */
3365 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3366 if (size <= 0) {
3367 printf("Unexpected klogctl return value: %d\n\n", size);
3368 return;
3369 }
3370 char *buf = (char *) malloc(size + 1);
3371 if (buf == nullptr) {
3372 printf("memory allocation failed\n\n");
3373 return;
3374 }
3375 int retval = klogctl(KLOG_READ_ALL, buf, size);
3376 if (retval < 0) {
3377 printf("klogctl failure\n\n");
3378 free(buf);
3379 return;
3380 }
3381 buf[retval] = '\0';
3382 printf("%s\n\n", buf);
3383 free(buf);
3384 return;
3385}
3386
3387void do_showmap(int pid, const char *name) {
3388 char title[255];
3389 char arg[255];
3390
3391 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3392 snprintf(arg, sizeof(arg), "%d", pid);
3393 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3394}
3395
3396int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3397 DurationReporter duration_reporter(title);
3398
3399 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3400
3401 UpdateProgress(WEIGHT_FILE);
3402
3403 return status;
3404}
3405
3406int read_file_as_long(const char *path, long int *output) {
3407 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3408 if (fd < 0) {
3409 int err = errno;
3410 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3411 return -1;
3412 }
3413 char buffer[50];
3414 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3415 if (bytes_read == -1) {
3416 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3417 return -2;
3418 }
3419 if (bytes_read == 0) {
3420 MYLOGE("File %s is empty\n", path);
3421 return -3;
3422 }
3423 *output = atoi(buffer);
3424 return 0;
3425}
3426
3427/* calls skip to gate calling dump_from_fd recursively
3428 * in the specified directory. dump_from_fd defaults to
3429 * dump_file_from_fd above when set to NULL. skip defaults
3430 * to false when set to NULL. dump_from_fd will always be
3431 * called with title NULL.
3432 */
3433int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3434 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3435 DurationReporter duration_reporter(title);
3436 DIR *dirp;
3437 struct dirent *d;
3438 char *newpath = nullptr;
3439 const char *slash = "/";
3440 int retval = 0;
3441
3442 if (!title.empty()) {
3443 printf("------ %s (%s) ------\n", title.c_str(), dir);
3444 }
3445 if (PropertiesHelper::IsDryRun()) return 0;
3446
3447 if (dir[strlen(dir) - 1] == '/') {
3448 ++slash;
3449 }
3450 dirp = opendir(dir);
3451 if (dirp == nullptr) {
3452 retval = -errno;
3453 MYLOGE("%s: %s\n", dir, strerror(errno));
3454 return retval;
3455 }
3456
3457 if (!dump_from_fd) {
3458 dump_from_fd = dump_file_from_fd;
3459 }
3460 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3461 if ((d->d_name[0] == '.')
3462 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3463 || (d->d_name[1] == '\0'))) {
3464 continue;
3465 }
3466 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3467 (d->d_type == DT_DIR) ? "/" : "");
3468 if (!newpath) {
3469 retval = -errno;
3470 continue;
3471 }
3472 if (skip && (*skip)(newpath)) {
3473 continue;
3474 }
3475 if (d->d_type == DT_DIR) {
3476 int ret = dump_files("", newpath, skip, dump_from_fd);
3477 if (ret < 0) {
3478 retval = ret;
3479 }
3480 continue;
3481 }
3482 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3483 if (fd.get() < 0) {
3484 retval = -1;
3485 printf("*** %s: %s\n", newpath, strerror(errno));
3486 continue;
3487 }
3488 (*dump_from_fd)(nullptr, newpath, fd.get());
3489 }
3490 closedir(dirp);
3491 if (!title.empty()) {
3492 printf("\n");
3493 }
3494 return retval;
3495}
3496
3497/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3498 * it's possible to avoid issues where opening the file itself can get
3499 * stuck.
3500 */
3501int dump_file_from_fd(const char *title, const char *path, int fd) {
3502 if (PropertiesHelper::IsDryRun()) return 0;
3503
3504 int flags = fcntl(fd, F_GETFL);
3505 if (flags == -1) {
3506 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3507 return -1;
3508 } else if (!(flags & O_NONBLOCK)) {
3509 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3510 return -1;
3511 }
3512 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3513}
3514
3515int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003516 const CommandOptions& options, bool verbose_duration) {
3517 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003518
3519 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3520
3521 /* TODO: for now we're simplifying the progress calculation by using the
3522 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3523 * where its weight should be much higher proportionally to its timeout.
3524 * Ideally, it should use a options.EstimatedDuration() instead...*/
3525 UpdateProgress(options.Timeout());
3526
3527 return status;
3528}
3529
3530void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3531 const CommandOptions& options, long dumpsysTimeoutMs) {
3532 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3533 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3534 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3535 RunCommand(title, dumpsys, options);
3536}
3537
3538int open_socket(const char *service) {
3539 int s = android_get_control_socket(service);
3540 if (s < 0) {
3541 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3542 return -1;
3543 }
3544 fcntl(s, F_SETFD, FD_CLOEXEC);
3545
3546 // Set backlog to 0 to make sure that queue size will be minimum.
3547 // In Linux, because the minimum queue will be 1, connect() will be blocked
3548 // if the other clients already called connect() and the connection request was not accepted.
3549 if (listen(s, 0) < 0) {
3550 MYLOGE("listen(control socket): %s\n", strerror(errno));
3551 return -1;
3552 }
3553
3554 struct sockaddr addr;
3555 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003556 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003557
3558 // Close socket just after accept(), to make sure that connect() by client will get error
3559 // when the socket is used by the other services.
3560 // There is still a race condition possibility between accept and close, but there is no way
3561 // to close-on-accept atomically.
3562 // See detail; b/123306389#comment25
3563 close(s);
3564
3565 if (fd < 0) {
3566 MYLOGE("accept(control socket): %s\n", strerror(errno));
3567 return -1;
3568 }
3569
3570 return fd;
3571}
3572
3573/* redirect output to a service control socket */
3574bool redirect_to_socket(FILE* redirect, const char* service) {
3575 int fd = open_socket(service);
3576 if (fd == -1) {
3577 return false;
3578 }
3579 fflush(redirect);
3580 // TODO: handle dup2 failure
3581 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3582 close(fd);
3583 return true;
3584}
3585
3586// TODO: should call is_valid_output_file and/or be merged into it.
3587void create_parent_dirs(const char *path) {
3588 char *chp = const_cast<char *> (path);
3589
3590 /* skip initial slash */
3591 if (chp[0] == '/')
3592 chp++;
3593
3594 /* create leading directories, if necessary */
3595 struct stat dir_stat;
3596 while (chp && chp[0]) {
3597 chp = strchr(chp, '/');
3598 if (chp) {
3599 *chp = 0;
3600 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3601 MYLOGI("Creating directory %s\n", path);
3602 if (mkdir(path, 0770)) { /* drwxrwx--- */
3603 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3604 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3605 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3606 }
3607 }
3608 *chp++ = '/';
3609 }
3610 }
3611}
3612
3613bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3614 create_parent_dirs(path);
3615
3616 int fd = TEMP_FAILURE_RETRY(open(path,
3617 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3618 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3619 if (fd < 0) {
3620 MYLOGE("%s: %s\n", path, strerror(errno));
3621 return false;
3622 }
3623
3624 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3625 close(fd);
3626 return true;
3627}
3628
3629bool redirect_to_file(FILE* redirect, char* path) {
3630 return _redirect_to_file(redirect, path, O_TRUNC);
3631}
3632
3633bool redirect_to_existing_file(FILE* redirect, char* path) {
3634 return _redirect_to_file(redirect, path, O_APPEND);
3635}
3636
3637void dump_route_tables() {
3638 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3639 if (PropertiesHelper::IsDryRun()) return;
3640 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3641 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3642 FILE* fp = fopen(RT_TABLES_PATH, "re");
3643 if (!fp) {
3644 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3645 return;
3646 }
3647 char table[16];
3648 // Each line has an integer (the table number), a space, and a string (the table name). We only
3649 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3650 // Add a fixed max limit so this doesn't go awry.
3651 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3652 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3653 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3654 }
3655 fclose(fp);
3656}
3657
3658// TODO: make this function thread safe if sections are generated in parallel.
3659void Dumpstate::UpdateProgress(int32_t delta_sec) {
3660 if (progress_ == nullptr) {
3661 MYLOGE("UpdateProgress: progress_ not set\n");
3662 return;
3663 }
3664
3665 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003666 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003667
3668 // ...but only notifiy listeners when necessary.
3669 if (!options_->do_progress_updates) return;
3670
3671 int progress = progress_->Get();
3672 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003673 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003674
Nandana Duttf02cd782019-06-14 14:25:13 +01003675 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003676 return;
3677 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003678 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003679
3680 if (control_socket_fd_ >= 0) {
3681 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3682 fsync(control_socket_fd_);
3683 }
3684
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003685 if (listener_ != nullptr) {
3686 if (percent % 5 == 0) {
3687 // We don't want to spam logcat, so only log multiples of 5.
3688 MYLOGD("Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(), progress, max,
3689 percent);
3690 } else {
3691 // stderr is ignored on normal invocations, but useful when calling
3692 // /system/bin/dumpstate directly for debuggging.
3693 fprintf(stderr, "Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(),
3694 progress, max, percent);
3695 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003696
3697 listener_->onProgress(percent);
3698 }
3699}
3700
3701void Dumpstate::TakeScreenshot(const std::string& path) {
3702 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3703 int status =
3704 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3705 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3706 if (status == 0) {
3707 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3708 } else {
3709 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3710 }
3711}
3712
3713bool is_dir(const char* pathname) {
3714 struct stat info;
3715 if (stat(pathname, &info) == -1) {
3716 return false;
3717 }
3718 return S_ISDIR(info.st_mode);
3719}
3720
3721time_t get_mtime(int fd, time_t default_mtime) {
3722 struct stat info;
3723 if (fstat(fd, &info) == -1) {
3724 return default_mtime;
3725 }
3726 return info.st_mtime;
3727}