blob: 4688cedc96073516ea0277ccc606d42d8b5ddc3b [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"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700157
Narayan Kamath8f788292017-05-25 13:20:39 +0100158// TODO(narayan): Since this information has to be kept in sync
159// with tombstoned, we should just put it in a common header.
160//
161// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100162static const std::string TOMBSTONE_DIR = "/data/tombstones/";
163static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
164static const std::string ANR_DIR = "/data/anr/";
165static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700166
Felipe Lemee844a9d2016-09-21 15:01:39 -0700167// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000168
Nandana Dutt5c390032019-03-12 10:52:56 +0000169#define RETURN_IF_USER_DENIED_CONSENT() \
170 if (ds.IsUserConsentDenied()) { \
171 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
172 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
173 }
174
175// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
176// if consent is found to be denied.
177#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
178 RETURN_IF_USER_DENIED_CONSENT(); \
179 func_ptr(__VA_ARGS__); \
180 RETURN_IF_USER_DENIED_CONSENT();
181
Sahana Raof35ed432019-07-12 10:47:52 +0100182static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
183
Nandana Dutt979388e2018-11-30 16:48:55 +0000184namespace android {
185namespace os {
186namespace {
187
188static int Open(std::string path, int flags, mode_t mode = 0) {
189 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
190 if (fd == -1) {
191 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
192 }
193 return fd;
194}
195
Nandana Dutt979388e2018-11-30 16:48:55 +0000196
197static int OpenForRead(std::string path) {
198 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
199}
200
201bool CopyFile(int in_fd, int out_fd) {
202 char buf[4096];
203 ssize_t byte_count;
204 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
205 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
206 return false;
207 }
208 }
209 return (byte_count != -1);
210}
211
212static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000213 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000214
215 // Obtain a handle to the source file.
216 android::base::unique_fd in_fd(OpenForRead(input_file));
217 if (out_fd != -1 && in_fd.get() != -1) {
218 if (CopyFile(in_fd.get(), out_fd)) {
219 return true;
220 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000221 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000222 }
223 return false;
224}
225
Nandana Duttd2f5f082019-01-18 17:13:52 +0000226static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000227 if (unlink(file.c_str())) {
228 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000229 return false;
230 }
231 return true;
232}
Nandana Dutt979388e2018-11-30 16:48:55 +0000233
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000234
Nikita Ioffea325a572019-05-16 19:49:47 +0100235int64_t GetModuleMetadataVersion() {
236 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
237 if (binder == nullptr) {
238 MYLOGE("Failed to retrieve package_native service");
239 return 0L;
240 }
241 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
242 std::string package_name;
243 auto status = package_service->getModuleMetadataPackageName(&package_name);
244 if (!status.isOk()) {
245 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
246 return 0L;
247 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100248 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100249 int64_t version_code;
250 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
251 &version_code);
252 if (!status.isOk()) {
253 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
254 return 0L;
255 }
256 return version_code;
257}
258
Nandana Dutt979388e2018-11-30 16:48:55 +0000259} // namespace
260} // namespace os
261} // namespace android
262
Felipe Leme678727a2016-09-21 17:22:11 -0700263static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800264 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800265 long dumpsysTimeoutMs = 0) {
266 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700267}
268static int DumpFile(const std::string& title, const std::string& path) {
269 return ds.DumpFile(title, path);
270}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800271
Felipe Lemee844a9d2016-09-21 15:01:39 -0700272// Relative directory (inside the zip) for all files copied as-is into the bugreport.
273static const std::string ZIP_ROOT_DIR = "FS";
274
Vishnu Naire97d6122018-01-18 13:58:56 -0800275static const std::string kProtoPath = "proto/";
276static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700277static const std::string kDumpstateBoardFiles[] = {
278 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700279 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700280};
281static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
282
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700283static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700284static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700285
Felipe Lemef0292972016-11-22 13:57:05 -0800286static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
287
Narayan Kamath8f788292017-05-25 13:20:39 +0100288/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100289 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
290 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
291 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100292 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700293static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
294 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700295 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100296 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
297
Narayan Kamathbd863722017-06-01 18:50:12 +0100298 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100299
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700300 if (dump_dir == nullptr) {
301 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700302 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700303 }
304
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700305 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100306 struct dirent* entry = nullptr;
307 while ((entry = readdir(dump_dir.get()))) {
308 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100309 continue;
310 }
311
Narayan Kamathbd863722017-06-01 18:50:12 +0100312 const std::string base_name(entry->d_name);
313 if (base_name.find(file_prefix) != 0) {
314 continue;
315 }
316
317 const std::string abs_path = dir_path + base_name;
318 android::base::unique_fd fd(
319 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
320 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700321 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100322 break;
323 }
324
325 struct stat st = {};
326 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700327 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100328 continue;
329 }
330
Narayan Kamath3f31b632018-02-22 19:42:36 +0000331 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100332 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100333 continue;
334 }
335
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700336 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700337 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100338
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700339 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100340}
341
Narayan Kamathbd863722017-06-01 18:50:12 +0100342static bool AddDumps(const std::vector<DumpData>::const_iterator start,
343 const std::vector<DumpData>::const_iterator end,
344 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100345 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100346 for (auto it = start; it != end; ++it) {
347 const std::string& name = it->name;
348 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100349 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100350
351 // Seek to the beginning of the file before dumping any data. A given
352 // DumpData entry might be dumped multiple times in the report.
353 //
354 // For example, the most recent ANR entry is dumped to the body of the
355 // main entry and it also shows up as a separate entry in the bugreport
356 // ZIP file.
357 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
358 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
359 strerror(errno));
360 }
361
Narayan Kamath8f788292017-05-25 13:20:39 +0100362 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800363 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100364 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100365 }
366 } else {
367 dump_file_from_fd(type_name, name.c_str(), fd);
368 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100369 }
370
371 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700372}
373
Felipe Leme635ca312016-01-05 14:23:02 -0800374// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700375void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800376 char path[PATH_MAX];
377
378 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
379 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700380 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800381 char linkname[PATH_MAX];
382 ssize_t r = readlink(path, linkname, PATH_MAX);
383 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800384 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800385 return;
386 }
387 linkname[r] = '\0';
388
389 if (mount_points.find(linkname) == mount_points.end()) {
390 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700391 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700392 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800393 mount_points.insert(linkname);
394 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800395 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800396 }
397 }
398}
399
400void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700401 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700402 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800403 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800404 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700405 for_each_pid(do_mountinfo, nullptr);
406 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800407}
408
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700409static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
410{
411 DIR *d;
412 struct dirent *de;
413 char path[PATH_MAX];
414
415 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700416 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700417 return;
418 }
419
420 while ((de = readdir(d))) {
421 if (de->d_type != DT_LNK) {
422 continue;
423 }
424 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700425 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700426 }
427
428 closedir(d);
429}
430
Mark Salyzyn326842f2015-04-30 09:49:41 -0700431static bool skip_not_stat(const char *path) {
432 static const char stat[] = "/stat";
433 size_t len = strlen(path);
434 if (path[len - 1] == '/') { /* Directory? */
435 return false;
436 }
437 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
438}
439
Felipe Leme4c2d6632016-09-28 14:32:00 -0700440static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800441 return false;
442}
443
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700444unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700445
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800446//
447// stat offsets
448// Name units description
449// ---- ----- -----------
450// read I/Os requests number of read I/Os processed
451#define __STAT_READ_IOS 0
452// read merges requests number of read I/Os merged with in-queue I/O
453#define __STAT_READ_MERGES 1
454// read sectors sectors number of sectors read
455#define __STAT_READ_SECTORS 2
456// read ticks milliseconds total wait time for read requests
457#define __STAT_READ_TICKS 3
458// write I/Os requests number of write I/Os processed
459#define __STAT_WRITE_IOS 4
460// write merges requests number of write I/Os merged with in-queue I/O
461#define __STAT_WRITE_MERGES 5
462// write sectors sectors number of sectors written
463#define __STAT_WRITE_SECTORS 6
464// write ticks milliseconds total wait time for write requests
465#define __STAT_WRITE_TICKS 7
466// in_flight requests number of I/Os currently in flight
467#define __STAT_IN_FLIGHT 8
468// io_ticks milliseconds total time this block device has been active
469#define __STAT_IO_TICKS 9
470// time_in_queue milliseconds total wait time for all requests
471#define __STAT_IN_QUEUE 10
472#define __STAT_NUMBER_FIELD 11
473//
474// read I/Os, write I/Os
475// =====================
476//
477// These values increment when an I/O request completes.
478//
479// read merges, write merges
480// =========================
481//
482// These values increment when an I/O request is merged with an
483// already-queued I/O request.
484//
485// read sectors, write sectors
486// ===========================
487//
488// These values count the number of sectors read from or written to this
489// block device. The "sectors" in question are the standard UNIX 512-byte
490// sectors, not any device- or filesystem-specific block size. The
491// counters are incremented when the I/O completes.
492#define SECTOR_SIZE 512
493//
494// read ticks, write ticks
495// =======================
496//
497// These values count the number of milliseconds that I/O requests have
498// waited on this block device. If there are multiple I/O requests waiting,
499// these values will increase at a rate greater than 1000/second; for
500// example, if 60 read requests wait for an average of 30 ms, the read_ticks
501// field will increase by 60*30 = 1800.
502//
503// in_flight
504// =========
505//
506// This value counts the number of I/O requests that have been issued to
507// the device driver but have not yet completed. It does not include I/O
508// requests that are in the queue but not yet issued to the device driver.
509//
510// io_ticks
511// ========
512//
513// This value counts the number of milliseconds during which the device has
514// had I/O requests queued.
515//
516// time_in_queue
517// =============
518//
519// This value counts the number of milliseconds that I/O requests have waited
520// on this block device. If there are multiple I/O requests waiting, this
521// value will increase as the product of the number of milliseconds times the
522// number of requests waiting (see "read ticks" above for an example).
523#define S_TO_MS 1000
524//
525
Mark Salyzyn326842f2015-04-30 09:49:41 -0700526static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800527 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700528 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700529 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700530 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700531 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700532 getline(&buffer, &i, fp);
533 fclose(fp);
534 if (!buffer) {
535 return -errno;
536 }
537 i = strlen(buffer);
538 while ((i > 0) && (buffer[i - 1] == '\n')) {
539 buffer[--i] = '\0';
540 }
541 if (!*buffer) {
542 free(buffer);
543 return 0;
544 }
545 z = true;
546 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800547 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700548 if (fields[i] != 0) {
549 z = false;
550 }
551 }
552 if (z) { /* never accessed */
553 free(buffer);
554 return 0;
555 }
556
Wei Wang509bb5d2017-06-09 14:42:12 -0700557 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
558 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700559 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700560
561 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
562 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
563 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700564 free(buffer);
565
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800566 if (fields[__STAT_IO_TICKS]) {
567 unsigned long read_perf = 0;
568 unsigned long read_ios = 0;
569 if (fields[__STAT_READ_TICKS]) {
570 unsigned long long divisor = fields[__STAT_READ_TICKS]
571 * fields[__STAT_IO_TICKS];
572 read_perf = ((unsigned long long)SECTOR_SIZE
573 * fields[__STAT_READ_SECTORS]
574 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
575 / divisor;
576 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
577 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
578 / divisor;
579 }
580
581 unsigned long write_perf = 0;
582 unsigned long write_ios = 0;
583 if (fields[__STAT_WRITE_TICKS]) {
584 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
585 * fields[__STAT_IO_TICKS];
586 write_perf = ((unsigned long long)SECTOR_SIZE
587 * fields[__STAT_WRITE_SECTORS]
588 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
589 / divisor;
590 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
591 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
592 / divisor;
593 }
594
595 unsigned queue = (fields[__STAT_IN_QUEUE]
596 + (fields[__STAT_IO_TICKS] >> 1))
597 / fields[__STAT_IO_TICKS];
598
599 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700600 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 -0800601 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700602 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 -0800603 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800604 }
605
606 /* bugreport timeout factor adjustment */
607 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
608 worst_write_perf = write_perf;
609 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700610 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700611 return 0;
612}
613
Yao Chenbe3bbc12018-01-17 16:31:10 -0800614static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
615
616/* timeout in ms to read a list of buffers */
617static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
618 unsigned long timeout_ms = 0;
619 for (const auto& buffer : buffers) {
620 log_id_t id = android_name_to_log_id(buffer.c_str());
621 unsigned long property_size = __android_logger_get_buffer_size(id);
622 /* Engineering margin is ten-fold our guess */
623 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
624 }
625 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700626}
627
Nandana Duttd2f5f082019-01-18 17:13:52 +0000628Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
629}
630
631android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
632 std::lock_guard<std::mutex> lock(lock_);
633 result_ = APPROVED;
634 MYLOGD("User approved consent to share bugreport\n");
635 return android::binder::Status::ok();
636}
637
638android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
639 std::lock_guard<std::mutex> lock(lock_);
640 result_ = DENIED;
641 MYLOGW("User denied consent to share bugreport\n");
642 return android::binder::Status::ok();
643}
644
645UserConsentResult Dumpstate::ConsentCallback::getResult() {
646 std::lock_guard<std::mutex> lock(lock_);
647 return result_;
648}
649
650uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
651 return Nanotime() - start_time_;
652}
653
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700654void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700655 std::string build, fingerprint, radio, bootloader, network;
656 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700657
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700658 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
659 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700660 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
661 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
662 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700663 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700664
Felipe Lemed8b94e52016-12-08 10:21:44 -0800665 printf("========================================================\n");
666 printf("== dumpstate: %s\n", date);
667 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700668
Felipe Lemed8b94e52016-12-08 10:21:44 -0800669 printf("\n");
670 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700671 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800672 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
673 printf("Bootloader: %s\n", bootloader.c_str());
674 printf("Radio: %s\n", radio.c_str());
675 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100676 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
677 if (module_metadata_version != 0) {
678 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
679 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700680
Felipe Lemed8b94e52016-12-08 10:21:44 -0800681 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800682 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800683 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800684 printf("Uptime: ");
685 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
686 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800687 printf("Bugreport format version: %s\n", version_.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +0100688 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s bugreport_mode=%s\n", id_, pid_,
689 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800690 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800691}
692
Felipe Leme24b66ee2016-06-16 10:55:26 -0700693// List of file extensions that can cause a zip file attachment to be rejected by some email
694// service providers.
695static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
696 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
697 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
698 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
699};
700
Vishnu Naire97d6122018-01-18 13:58:56 -0800701status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
702 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700703 if (!IsZipping()) {
704 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
705 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800706 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800707 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700708 std::string valid_name = entry_name;
709
710 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700711 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700712 if (idx != std::string::npos) {
713 std::string extension = entry_name.substr(idx);
714 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
715 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
716 valid_name = entry_name + ".renamed";
717 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
718 }
719 }
720
Felipe Leme6fe9db62016-02-12 09:04:16 -0800721 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
722 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700723 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
724 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700725 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700726 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700727 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800728 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800729 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000730 bool finished_entry = false;
731 auto finish_entry = [this, &finished_entry] {
732 if (!finished_entry) {
733 // This should only be called when we're going to return an earlier error,
734 // which would've been logged. This may imply the file is already corrupt
735 // and any further logging from FinishEntry is more likely to mislead than
736 // not.
737 this->zip_writer_->FinishEntry();
738 }
739 };
740 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800741 auto start = std::chrono::steady_clock::now();
742 auto end = start + timeout;
743 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800744
Felipe Leme770410d2016-01-26 17:07:14 -0800745 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800746 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800747 if (timeout.count() > 0) {
748 // lambda to recalculate the timeout.
749 auto time_left_ms = [end]() {
750 auto now = std::chrono::steady_clock::now();
751 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
752 return std::max(diff.count(), 0LL);
753 };
754
755 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
756 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000757 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
758 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800759 return -errno;
760 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000761 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800762 entry_name.c_str(), strerror(errno), timeout.count());
763 return TIMED_OUT;
764 }
765 }
766
Zach Riggle22200402016-08-18 01:01:24 -0400767 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800768 if (bytes_read == 0) {
769 break;
770 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800771 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800772 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800773 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700774 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800775 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700776 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800777 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800778 }
779 }
780
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700781 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000782 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700783 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700784 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800785 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800786 }
787
Vishnu Naire97d6122018-01-18 13:58:56 -0800788 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800789}
790
Felipe Leme1d486fe2016-10-14 18:06:47 -0700791bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
792 android::base::unique_fd fd(
793 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700794 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800795 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800796 return false;
797 }
798
Vishnu Naire97d6122018-01-18 13:58:56 -0800799 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800800}
801
802/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700803static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800804 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800805}
806
Felipe Leme1d486fe2016-10-14 18:06:47 -0700807void Dumpstate::AddDir(const std::string& dir, bool recursive) {
808 if (!IsZipping()) {
809 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800810 return;
811 }
Felipe Leme678727a2016-09-21 17:22:11 -0700812 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800813 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700814 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800815}
816
Felipe Leme1d486fe2016-10-14 18:06:47 -0700817bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
818 if (!IsZipping()) {
819 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
820 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800821 return false;
822 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800823 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700824 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700825 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700826 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700827 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800828 return false;
829 }
830
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700831 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700832 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700833 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700834 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800835 return false;
836 }
837
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700838 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700839 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700840 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800841 return false;
842 }
843
844 return true;
845}
846
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800847static void DoKmsg() {
848 struct stat st;
849 if (!stat(PSTORE_LAST_KMSG, &st)) {
850 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
851 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
852 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
853 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
854 } else {
855 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
856 DumpFile("LAST KMSG", "/proc/last_kmsg");
857 }
858}
859
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800860static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800861 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800862 RunCommand(
863 "KERNEL LOG",
864 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
865 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
866}
867
Nandana Duttdb379fa2019-10-09 16:54:41 +0100868static void DoSystemLogcat(time_t since) {
869 char since_str[80];
870 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
871
872 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
873 RunCommand("SYSTEM LOG",
874 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
875 since_str},
876 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
877}
878
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800879static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800880 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800881 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
882 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800883 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100884 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800885 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
886 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800887 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800888 RunCommand(
889 "EVENT LOG",
890 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100891 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800892 timeout_ms = logcat_timeout({"stats"});
893 RunCommand(
894 "STATS LOG",
895 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100896 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800897 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800898 RunCommand(
899 "RADIO LOG",
900 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100901 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800902
903 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
904
905 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800906 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
907 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800908}
909
Mike Ma5c267872019-08-21 11:31:34 -0700910static void DumpIncidentReport() {
911 if (!ds.IsZipping()) {
912 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
913 return;
914 }
915 DurationReporter duration_reporter("INCIDENT REPORT");
916 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
917 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
918 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
919 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
920 if (fd < 0) {
921 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
922 return;
923 }
924 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
925 bool empty = 0 == lseek(fd, 0, SEEK_END);
926 if (!empty) {
927 // Use a different name from "incident.proto"
928 // /proto/incident.proto is reserved for incident service dump
929 // i.e. metadata for debugging.
930 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
931 }
932 unlink(path.c_str());
933}
934
Jayachandran Ca94c7172017-06-10 15:08:12 -0700935static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700936 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
937 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900938 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700939 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900940 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
941 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
942 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
943 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700944}
945
David Andersond9ba4752018-12-11 18:26:59 -0800946static void DumpDynamicPartitionInfo() {
947 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
948 return;
949 }
950
951 RunCommand("LPDUMP", {"lpdump", "--all"});
952}
953
Narayan Kamath8f788292017-05-25 13:20:39 +0100954static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
955 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
956 anr_traces_dir.c_str());
957
958 // If we're here, dump_traces_path will always be a temporary file
959 // (created with mkostemp or similar) that contains dumps taken earlier
960 // on in the process.
961 if (dump_traces_path != nullptr) {
962 if (add_to_zip) {
963 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
964 } else {
965 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
966 dump_traces_path);
967 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
968 }
969
970 const int ret = unlink(dump_traces_path);
971 if (ret == -1) {
972 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
973 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700974 }
975 }
976
Narayan Kamathbd863722017-06-01 18:50:12 +0100977 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700978 if (ds.anr_data_.size() > 0) {
979 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100980 "VM TRACES AT LAST ANR", add_to_zip);
981
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100982 // The "last" ANR will always be included as separate entry in the zip file. In addition,
983 // it will be present in the body of the main entry if |add_to_zip| == false.
984 //
985 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700986 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100987 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +0100988 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +0100989 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
990 }
991}
992
993static void AddAnrTraceFiles() {
994 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
995
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700996 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +0100997
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700998 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100999
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001000 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1001
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001002 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001003 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001004 int i = 0;
1005 while (true) {
1006 const std::string slow_trace_path =
1007 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1008 if (stat(slow_trace_path.c_str(), &st)) {
1009 // No traces file at this index, done with the files.
1010 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001011 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001012 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1013 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001014 }
1015}
1016
Wei Wang509bb5d2017-06-09 14:42:12 -07001017static void DumpBlockStatFiles() {
1018 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001019
Wei Wang1dc1ef52017-06-12 11:28:37 -07001020 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1021
1022 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001023 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1024 return;
1025 }
1026
1027 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001028 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001029 if ((d->d_name[0] == '.')
1030 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1031 || (d->d_name[1] == '\0'))) {
1032 continue;
1033 }
1034 const std::string new_path =
1035 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1036 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1037 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1038 printf("\n");
1039 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001040 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001041}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001042
1043static void DumpPacketStats() {
1044 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1045 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1046 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1047 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1048 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1049}
1050
1051static void DumpIpAddrAndRules() {
1052 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1053 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1054 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1055 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1056 RunCommand("IP RULES", {"ip", "rule", "show"});
1057 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1058}
1059
Nandana Dutt5c390032019-03-12 10:52:56 +00001060static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1061 std::chrono::milliseconds timeout,
1062 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001063 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001064 sp<android::IServiceManager> sm = defaultServiceManager();
1065 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001066 Vector<String16> args;
1067 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001068 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1069 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001070 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001071 std::string path(title);
1072 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001073 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001074 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001075 if (status == OK) {
1076 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1077 std::chrono::duration<double> elapsed_seconds;
1078 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1079 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001080 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1081 bool dump_complete = (status == OK);
1082 dumpsys.stopDumpThread(dump_complete);
1083 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001084
1085 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1086 std::chrono::steady_clock::now() - start);
1087 if (elapsed_duration > timeout) {
1088 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1089 elapsed_duration.count());
1090 break;
1091 }
1092 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001093 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001094}
1095
Vishnu Nair64afc022018-02-01 15:29:34 -08001096static void RunDumpsysText(const std::string& title, int priority,
1097 std::chrono::milliseconds timeout,
1098 std::chrono::milliseconds service_timeout) {
1099 DurationReporter duration_reporter(title);
1100 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1101 fsync(STDOUT_FILENO);
1102 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1103}
1104
1105/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001106static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1107 std::chrono::milliseconds timeout,
1108 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001109 DurationReporter duration_reporter(title);
1110 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1111 fsync(STDOUT_FILENO);
1112 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1113 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001114
1115 RETURN_IF_USER_DENIED_CONSENT();
1116
1117 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1118 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001119}
1120
Nandana Dutt5c390032019-03-12 10:52:56 +00001121static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1122 std::chrono::milliseconds timeout,
1123 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001124 if (!ds.IsZipping()) {
1125 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001126 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001127 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001128 sp<android::IServiceManager> sm = defaultServiceManager();
1129 Dumpsys dumpsys(sm.get());
1130 Vector<String16> args;
1131 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1132 DurationReporter duration_reporter(title);
1133
1134 auto start = std::chrono::steady_clock::now();
1135 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1136 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001137 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001138 std::string path(kProtoPath);
1139 path.append(String8(service).c_str());
1140 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1141 path.append("_CRITICAL");
1142 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1143 path.append("_HIGH");
1144 }
1145 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001146 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001147 if (status == OK) {
1148 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1149 bool dumpTerminated = (status == OK);
1150 dumpsys.stopDumpThread(dumpTerminated);
1151 }
1152 ZipWriter::FileEntry file_entry;
1153 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001154
1155 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1156 std::chrono::steady_clock::now() - start);
1157 if (elapsed_duration > timeout) {
1158 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1159 elapsed_duration.count());
1160 break;
1161 }
1162 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001163 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001164}
1165
Nandana Dutta7db6342018-11-21 14:53:34 +00001166// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001167static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001168 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1169 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001170
1171 RETURN_IF_USER_DENIED_CONSENT();
1172
1173 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1174 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001175}
1176
1177// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001178static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001179 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1180 // high priority. Reduce timeout once they are able to dump in a shorter time or
1181 // moved to a parallel task.
1182 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1183 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001184
1185 RETURN_IF_USER_DENIED_CONSENT();
1186
1187 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1188 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001189}
1190
1191// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001192static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001193 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001194
1195 RETURN_IF_USER_DENIED_CONSENT();
1196
1197 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1198 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001199}
1200
Steven Moreland44cd9482018-01-04 16:24:13 -08001201static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001202 if (!ds.IsZipping()) {
1203 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1204 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1205 return;
1206 }
1207 DurationReporter duration_reporter("DUMP HALS");
1208 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001209 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001210
Steven Moreland44cd9482018-01-04 16:24:13 -08001211 using android::hidl::manager::V1_0::IServiceManager;
1212 using android::hardware::defaultServiceManager;
1213
1214 sp<IServiceManager> sm = defaultServiceManager();
1215 if (sm == nullptr) {
1216 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1217 return;
1218 }
1219
1220 auto ret = sm->list([&](const auto& interfaces) {
1221 for (const std::string& interface : interfaces) {
1222 std::string cleanName = interface;
1223 std::replace_if(cleanName.begin(),
1224 cleanName.end(),
1225 [](char c) {
1226 return !isalnum(c) &&
1227 std::string("@-_:.").find(c) == std::string::npos;
1228 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001229 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001230
1231 {
1232 auto fd = android::base::unique_fd(
1233 TEMP_FAILURE_RETRY(open(path.c_str(),
1234 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1235 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1236 if (fd < 0) {
1237 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1238 continue;
1239 }
1240 RunCommandToFd(fd,
1241 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001242 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001243 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1244
1245 bool empty = 0 == lseek(fd, 0, SEEK_END);
1246 if (!empty) {
1247 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1248 }
1249 }
1250
1251 unlink(path.c_str());
1252 }
1253 });
1254
1255 if (!ret.isOk()) {
1256 MYLOGE("Could not list hals from hwservicemanager.\n");
1257 }
1258}
1259
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001260static void DumpExternalFragmentationInfo() {
1261 struct stat st;
1262 if (stat("/proc/buddyinfo", &st) != 0) {
1263 MYLOGE("Unable to dump external fragmentation info\n");
1264 return;
1265 }
1266
1267 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1268 std::ifstream ifs("/proc/buddyinfo");
1269 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1270 for (std::string line; std::getline(ifs, line);) {
1271 std::smatch match_results;
1272 if (std::regex_match(line, match_results, unusable_index_regex)) {
1273 std::stringstream free_pages(std::string{match_results[3]});
1274 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1275 std::istream_iterator<int>());
1276
1277 int total_free_pages = 0;
1278 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1279 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1280 }
1281
1282 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1283 match_results[2].str().c_str());
1284
1285 int usable_free_pages = total_free_pages;
1286 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1287 auto unusable_index = (total_free_pages - usable_free_pages) /
1288 static_cast<double>(total_free_pages);
1289 printf(" %5.3f", unusable_index);
1290 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1291 }
1292
1293 printf("\n");
1294 }
1295 }
1296 printf("\n");
1297}
1298
Nandana Dutt5c390032019-03-12 10:52:56 +00001299// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1300// via the consent they are shown. Ignores other errors that occur while running various
1301// commands. The consent checking is currently done around long running tasks, which happen to
1302// be distributed fairly evenly throughout the function.
1303static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001304 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001305
Nandana Dutt5c390032019-03-12 10:52:56 +00001306 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1307 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1308 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001309 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001310 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001311 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001312 DumpFile("MEMORY INFO", "/proc/meminfo");
1313 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001314 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001315
1316 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1317
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001318 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1319 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1320 DumpFile("SLAB INFO", "/proc/slabinfo");
1321 DumpFile("ZONEINFO", "/proc/zoneinfo");
1322 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1323 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001324 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001325
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001326 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1327 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001328
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001329 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001330 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001331
1332 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1333 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001334
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001335 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001336
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001337 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001338 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001339 struct stat s;
1340 if (stat("/proc/modules", &s) != 0) {
1341 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1342 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001343 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001344 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001345
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001346 if (__android_logger_property_get_bool(
1347 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1348 DoKernelLogcat();
1349 } else {
1350 do_dmesg();
1351 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001352
Felipe Lemef0292972016-11-22 13:57:05 -08001353 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001354
1355 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1356
Jeff Brown1dc94e32014-09-11 14:15:27 -07001357 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001358 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001359
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001360 /* Dump Bluetooth HCI logs */
1361 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001362
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001363 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001364 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001365 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001366 }
1367
Felipe Lemee184f662016-10-27 10:04:47 -07001368 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001369
Narayan Kamath8f788292017-05-25 13:20:39 +01001370 // NOTE: tombstones are always added as separate entries in the zip archive
1371 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001372 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001373 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001374 if (!tombstones_dumped) {
1375 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001376 }
1377
Jayachandran Ca94c7172017-06-10 15:08:12 -07001378 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001379
Chenbo Feng276a3b62018-08-07 11:44:49 -07001380 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1381
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001382 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001383
Jayachandran Ca94c7172017-06-10 15:08:12 -07001384 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001385
1386 dump_route_tables();
1387
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001388 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1389 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1390 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001391
Nandana Dutt5c390032019-03-12 10:52:56 +00001392 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001393
Elliott Hughes23ccc622017-02-28 10:14:22 -08001394 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001395
Jin Qianf334d662017-10-10 14:41:37 -07001396 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001397
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001398 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001399
Colin Crossf45fa6b2012-03-26 12:38:26 -07001400 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001401 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1402 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1403 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1404 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1405 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001406
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001407 /* Add window and surface trace files. */
1408 if (!PropertiesHelper::IsUserBuild()) {
1409 ds.AddDir(WMTRACE_DATA_DIR, false);
1410 }
1411
Nandana Dutt5c390032019-03-12 10:52:56 +00001412 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001413
Steven Moreland7440ddb2016-12-15 16:13:39 -08001414 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001415 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1416 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001417 // su does not exist on user builds, so try running without it.
1418 // This way any implementations of vril-dump that do not require
1419 // root can run on user builds.
1420 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001421 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001422 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001423 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001424 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001425 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001426 }
1427
Felipe Lemed8b94e52016-12-08 10:21:44 -08001428 printf("========================================================\n");
1429 printf("== Android Framework Services\n");
1430 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001431
Nandana Dutt5c390032019-03-12 10:52:56 +00001432 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001433
Felipe Lemed8b94e52016-12-08 10:21:44 -08001434 printf("========================================================\n");
1435 printf("== Checkins\n");
1436 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001437
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001438 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001439
1440 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1441
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001442 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1443 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1444 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1445 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001446
Felipe Lemed8b94e52016-12-08 10:21:44 -08001447 printf("========================================================\n");
1448 printf("== Running Application Activities\n");
1449 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001450
Makoto Onuki60780982018-04-16 15:34:00 -07001451 // The following dumpsys internally collects output from running apps, so it can take a long
1452 // time. So let's extend the timeout.
1453
1454 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1455
1456 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001457
Felipe Lemed8b94e52016-12-08 10:21:44 -08001458 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001459 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001460 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001461
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001462 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001463 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001464
Felipe Lemed8b94e52016-12-08 10:21:44 -08001465 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001466 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001467 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001468
Makoto Onuki60780982018-04-16 15:34:00 -07001469 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1470 DUMPSYS_COMPONENTS_OPTIONS);
1471
1472 printf("========================================================\n");
1473 printf("== Running Application Providers (platform)\n");
1474 printf("========================================================\n");
1475
1476 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1477 DUMPSYS_COMPONENTS_OPTIONS);
1478
1479 printf("========================================================\n");
1480 printf("== Running Application Providers (non-platform)\n");
1481 printf("========================================================\n");
1482
1483 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1484 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001485
Adrian Roos8b397ab2017-04-04 16:35:44 -07001486 printf("========================================================\n");
1487 printf("== Dropbox crashes\n");
1488 printf("========================================================\n");
1489
1490 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1491 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1492
Felipe Lemed8b94e52016-12-08 10:21:44 -08001493 printf("========================================================\n");
1494 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1495 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1496 printf("========================================================\n");
1497 printf("== dumpstate: done (id %d)\n", ds.id_);
1498 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001499
1500 printf("========================================================\n");
1501 printf("== Obtaining statsd metadata\n");
1502 printf("========================================================\n");
1503 // This differs from the usual dumpsys stats, which is the stats report data.
1504 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001505
1506 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1507
Nandana Dutt5c390032019-03-12 10:52:56 +00001508 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001509}
1510
Nandana Dutt5c390032019-03-12 10:52:56 +00001511/*
1512 * Dumps state for the default case; drops root after it's no longer necessary.
1513 *
1514 * Returns RunStatus::OK if everything went fine.
1515 * Returns RunStatus::ERROR if there was an error.
1516 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1517 * with the caller.
1518 */
1519static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001520 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001521 // keep the system stats as close to its initial state as possible.
Nandana Dutt5c390032019-03-12 10:52:56 +00001522 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001523
Nandana Duttdb379fa2019-10-09 16:54:41 +01001524 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1525 // buffer.
1526 DoLogcat();
1527 // Capture timestamp after first logcat to use in next logcat
1528 time_t logcat_ts = time(nullptr);
1529
Nandana Dutt4be45d12018-09-26 15:04:23 +01001530 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001531 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001532
1533 /* Run some operations that require root. */
1534 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1535 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1536
1537 ds.AddDir(RECOVERY_DIR, true);
1538 ds.AddDir(RECOVERY_DATA_DIR, true);
1539 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1540 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1541 if (!PropertiesHelper::IsUserBuild()) {
1542 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1543 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1544 }
1545 add_mountinfo();
1546 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001547 DumpDynamicPartitionInfo();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001548
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001549 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001550 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1551
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001552 // Dump IPsec stats. No keys are exposed here.
1553 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1554
Nandana Dutt4be45d12018-09-26 15:04:23 +01001555 // Run ss as root so we can see socket marks.
1556 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1557
1558 // Run iotop as root to show top 100 IO threads
1559 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1560
Erick Reyese68df822019-02-11 14:46:36 -08001561 // Gather shared memory buffer info if the product implements it
1562 struct stat st;
1563 if (!stat("/product/bin/dmabuf_dump", &st)) {
1564 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1565 }
1566
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001567 DumpFile("PSI cpu", "/proc/pressure/cpu");
1568 DumpFile("PSI memory", "/proc/pressure/memory");
1569 DumpFile("PSI io", "/proc/pressure/io");
1570
Nandana Dutt4be45d12018-09-26 15:04:23 +01001571 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001572 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001573 }
1574
Nandana Dutt5c390032019-03-12 10:52:56 +00001575 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001576 Dumpstate::RunStatus status = dumpstate();
1577 // Capture logcat since the last time we did it.
1578 DoSystemLogcat(logcat_ts);
1579 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001580}
1581
mukesh agrawal253dad42018-01-23 21:59:59 -08001582// This method collects common dumpsys for telephony and wifi
1583static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001584 DumpIpTablesAsRoot();
1585
Jayachandran Cb4389d92019-07-08 09:46:05 -07001586 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1587
Jayachandran Ca94c7172017-06-10 15:08:12 -07001588 if (!DropRootUser()) {
1589 return;
1590 }
1591
1592 do_dmesg();
1593 DoLogcat();
1594 DumpPacketStats();
1595 DoKmsg();
1596 DumpIpAddrAndRules();
1597 dump_route_tables();
Jayachandran Cb4389d92019-07-08 09:46:05 -07001598 DumpHals();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001599
1600 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1601 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001602}
1603
1604// This method collects dumpsys for telephony debugging only
1605static void DumpstateTelephonyOnly() {
1606 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001607 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001608
1609 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001610
1611 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1612
1613 printf("========================================================\n");
1614 printf("== Android Framework Services\n");
1615 printf("========================================================\n");
1616
Vishnu Nair652cc802017-11-30 15:18:30 -08001617 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1618 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001619 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1620 SEC_TO_MSEC(10));
1621 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001622 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1623 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001624 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1625 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001626 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1627 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001628
1629 printf("========================================================\n");
1630 printf("== Running Application Services\n");
1631 printf("========================================================\n");
1632
1633 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1634
1635 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001636 printf("== Running Application Services (non-platform)\n");
1637 printf("========================================================\n");
1638
1639 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1640 DUMPSYS_COMPONENTS_OPTIONS);
1641
1642 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001643 printf("== Checkins\n");
1644 printf("========================================================\n");
1645
1646 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1647
1648 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001649 printf("== dumpstate: done (id %d)\n", ds.id_);
1650 printf("========================================================\n");
1651}
1652
mukesh agrawal253dad42018-01-23 21:59:59 -08001653// This method collects dumpsys for wifi debugging only
1654static void DumpstateWifiOnly() {
1655 DurationReporter duration_reporter("DUMPSTATE");
1656
1657 DumpstateRadioCommon();
1658
1659 printf("========================================================\n");
1660 printf("== Android Framework Services\n");
1661 printf("========================================================\n");
1662
1663 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1664 SEC_TO_MSEC(10));
1665 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1666 SEC_TO_MSEC(10));
1667
1668 printf("========================================================\n");
1669 printf("== dumpstate: done (id %d)\n", ds.id_);
1670 printf("========================================================\n");
1671}
1672
Nandana Duttcf419a72019-03-14 10:40:17 +00001673Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001674 DurationReporter duration_reporter("DUMP TRACES");
1675
1676 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1677 const size_t buf_size = temp_file_pattern.length() + 1;
1678 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1679 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1680
1681 // Create a new, empty file to receive all trace dumps.
1682 //
1683 // TODO: This can be simplified once we remove support for the old style
1684 // dumps. We can have a file descriptor passed in to dump_traces instead
1685 // of creating a file, closing it and then reopening it again.
1686 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1687 if (fd < 0) {
1688 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001689 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001690 }
1691
1692 // Nobody should have access to this temporary file except dumpstate, but we
1693 // temporarily grant 'read' to 'others' here because this file is created
1694 // when tombstoned is still running as root, but dumped after dropping. This
1695 // can go away once support for old style dumping has.
1696 const int chmod_ret = fchmod(fd, 0666);
1697 if (chmod_ret < 0) {
1698 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001699 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001700 }
1701
1702 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1703 if (proc.get() == nullptr) {
1704 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001705 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001706 }
1707
1708 // Number of times process dumping has timed out. If we encounter too many
1709 // failures, we'll give up.
1710 int timeout_failures = 0;
1711 bool dalvik_found = false;
1712
1713 const std::set<int> hal_pids = get_interesting_hal_pids();
1714
1715 struct dirent* d;
1716 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001717 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001718 int pid = atoi(d->d_name);
1719 if (pid <= 0) {
1720 continue;
1721 }
1722
1723 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1724 std::string exe;
1725 if (!android::base::Readlink(link_name, &exe)) {
1726 continue;
1727 }
1728
1729 bool is_java_process;
1730 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1731 // Don't bother dumping backtraces for the zygote.
1732 if (IsZygote(pid)) {
1733 continue;
1734 }
1735
1736 dalvik_found = true;
1737 is_java_process = true;
1738 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1739 is_java_process = false;
1740 } else {
1741 // Probably a native process we don't care about, continue.
1742 continue;
1743 }
1744
1745 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1746 if (timeout_failures == 3) {
1747 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1748 break;
1749 }
1750
1751 const uint64_t start = Nanotime();
1752 const int ret = dump_backtrace_to_file_timeout(
1753 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1754 is_java_process ? 5 : 20, fd);
1755
1756 if (ret == -1) {
1757 // For consistency, the header and footer to this message match those
1758 // dumped by debuggerd in the success case.
1759 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1760 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1761 dprintf(fd, "---- end %d ----", pid);
1762 timeout_failures++;
1763 continue;
1764 }
1765
1766 // We've successfully dumped stack traces, reset the failure count
1767 // and write a summary of the elapsed time to the file and continue with the
1768 // next process.
1769 timeout_failures = 0;
1770
1771 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1772 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1773 }
1774
1775 if (!dalvik_found) {
1776 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1777 }
1778
Nandana Duttcf419a72019-03-14 10:40:17 +00001779 *path = file_name_buf.release();
1780 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001781}
1782
Felipe Leme6f674ae2016-11-18 17:10:33 -08001783void Dumpstate::DumpstateBoard() {
1784 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001785 printf("========================================================\n");
1786 printf("== Board\n");
1787 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001788
Felipe Leme6f674ae2016-11-18 17:10:33 -08001789 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001790 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001791 return;
1792 }
1793
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001794 std::vector<std::string> paths;
1795 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001796 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001797 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1798 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001799 remover.emplace_back(android::base::make_scope_guard(
1800 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001801 }
Jie Song9fbfad02017-06-20 16:29:42 -07001802
Wei Wang587eac92018-04-05 12:17:20 -07001803 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1804 if (dumpstate_device == nullptr) {
1805 MYLOGE("No IDumpstateDevice implementation\n");
1806 return;
1807 }
1808
1809 using ScopedNativeHandle =
1810 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1811 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1812 [](native_handle_t* handle) {
1813 native_handle_close(handle);
1814 native_handle_delete(handle);
1815 });
1816 if (handle == nullptr) {
1817 MYLOGE("Could not create native_handle\n");
1818 return;
1819 }
1820
Nandana Dutt5c390032019-03-12 10:52:56 +00001821 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001822 for (size_t i = 0; i < paths.size(); i++) {
1823 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1824
1825 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1826 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1827 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1828 if (fd < 0) {
1829 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1830 return;
1831 }
1832 handle.get()->data[i] = fd.release();
1833 }
1834
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001835 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001836 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1837 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1838 // and grab whatever dumped
1839 std::packaged_task<bool()>
1840 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001841 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1842 if (!status.isOk()) {
1843 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001844 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001845 }
Wei Wang587eac92018-04-05 12:17:20 -07001846 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001847 });
Wei Wang587eac92018-04-05 12:17:20 -07001848
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001849 auto result = dumpstate_task.get_future();
1850 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001851
1852 constexpr size_t timeout_sec = 30;
1853 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1854 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1855 if (!android::base::SetProperty("ctl.interface_restart",
1856 android::base::StringPrintf("%s/default",
1857 IDumpstateDevice::descriptor))) {
1858 MYLOGE("Couldn't restart dumpstate HAL\n");
1859 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001860 }
Wei Wang587eac92018-04-05 12:17:20 -07001861 // Wait some time for init to kill dumpstate vendor HAL
1862 constexpr size_t killing_timeout_sec = 10;
1863 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1864 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1865 "there might be racing in content\n", killing_timeout_sec);
1866 }
1867
1868 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1869 for (size_t i = 0; i < paths.size(); i++) {
1870 struct stat s;
1871 if (fstat(handle.get()->data[i], &s) == -1) {
1872 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1873 strerror(errno));
1874 file_sizes[i] = -1;
1875 continue;
1876 }
1877 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001878 }
1879
1880 for (size_t i = 0; i < paths.size(); i++) {
1881 if (file_sizes[i] == -1) {
1882 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001883 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001884 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001885 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001886 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001887 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001888 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001889 }
1890
Felipe Lemed8b94e52016-12-08 10:21:44 -08001891 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001892}
1893
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001894static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001895 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001896 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Abhijeet Kaure370d682019-10-01 16:49:30 +01001897 "[-z]] [-s] [-S] [-q] [-P] [-R] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001898 " -h: display this help message\n"
1899 " -b: play sound file instead of vibrate, at beginning of job\n"
1900 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001901 " -d: append date to filename\n"
1902 " -p: capture screenshot to filename.png\n"
1903 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001904 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001905 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001906 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01001907 " -P: send broadcast when started and do progress updates\n"
1908 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001909 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001910 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001911}
1912
Wei Liuf87959e2016-08-26 14:51:42 -07001913static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001914 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001915}
1916
Felipe Leme1d486fe2016-10-14 18:06:47 -07001917bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001918 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001919 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001920 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001921 // Final timestamp
1922 char date[80];
1923 time_t the_real_now_please_stand_up = time(nullptr);
1924 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001925 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001926 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001927
Felipe Leme9a523ae2016-10-20 15:10:33 -07001928 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001929 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001930 return false;
1931 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001932 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001933 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001934 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001935 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001936
Felipe Leme0f3fb202016-06-10 17:10:53 -07001937 // Add log file (which contains stderr output) to zip...
1938 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001939 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001940 MYLOGE("Failed to add dumpstate log to .zip file\n");
1941 return false;
1942 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001943 // TODO: Should truncate the existing file.
1944 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001945 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1946 return false;
1947 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001948 fprintf(stderr, "\n");
1949
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001950 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001951 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001952 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001953 return false;
1954 }
1955
Felipe Leme1d486fe2016-10-14 18:06:47 -07001956 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1957 ds.zip_file.reset(nullptr);
1958
Felipe Lemee9d2c542016-11-15 11:48:26 -08001959 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001960 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001961
Felipe Leme1e9edc62015-12-21 16:02:13 -08001962 return true;
1963}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001964
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001965static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1966 // clang-format off
1967 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1968 "--receiver-foreground", "--receiver-include-background", "-a", action};
1969 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001970
1971 am.insert(am.end(), args.begin(), args.end());
1972
Felipe Leme8d2410e2017-02-08 09:46:08 -08001973 RunCommand("", am,
1974 CommandOptions::WithTimeout(20)
1975 .Log("Sending broadcast: '%s'\n")
1976 .Always()
1977 .DropRoot()
1978 .RedirectStderr()
1979 .Build());
1980}
1981
Felipe Leme35b8cf12017-02-10 15:47:29 -08001982static void Vibrate(int duration_ms) {
1983 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00001984 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08001985 CommandOptions::WithTimeout(10)
1986 .Log("Vibrate: '%s'\n")
1987 .Always()
1988 .Build());
1989 // clang-format on
1990}
1991
Nandana Dutt979388e2018-11-30 16:48:55 +00001992static void MaybeResolveSymlink(std::string* path) {
1993 std::string resolved_path;
1994 if (android::base::Readlink(*path, &resolved_path)) {
1995 *path = resolved_path;
1996 }
1997}
1998
Nandana Dutt4be45d12018-09-26 15:04:23 +01001999/*
2000 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2001 * if we are writing zip files and adds the version file.
2002 */
2003static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002004 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2005
Nandana Dutt4be45d12018-09-26 15:04:23 +01002006 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2007 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002008 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002009 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002010 char date[80];
2011 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2012 ds.name_ = date;
2013 } else {
2014 ds.name_ = "undated";
2015 }
2016
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002017 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002018 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002019 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002020 ds.base_name_ += "-wifi";
2021 }
2022
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002023 if (ds.options_->do_fb) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002024 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.png" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002025 }
2026 ds.tmp_path_ = ds.GetPath(".tmp");
2027 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2028
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002029 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002030 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002031 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002032 MYLOGD(
2033 "Bugreport dir: %s\n"
2034 "Base name: %s\n"
2035 "Suffix: %s\n"
2036 "Log path: %s\n"
2037 "Temporary path: %s\n"
2038 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002039 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2040 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002041
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002042 if (ds.options_->do_zip_file) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002043 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.zip" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002044 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2045 create_parent_dirs(ds.path_.c_str());
2046 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2047 if (ds.zip_file == nullptr) {
2048 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2049 } else {
2050 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2051 }
2052 ds.AddTextZipEntry("version.txt", ds.version_);
2053 }
2054}
2055
2056/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002057 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002058 * printing zipped file status, etc.
2059 */
2060static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002061 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002062 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002063 if (!ds.FinishZipFile()) {
2064 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2065 do_text_file = true;
2066 } else {
2067 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002068 }
2069 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002070 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002071 if (do_text_file) {
2072 dprintf(ds.control_socket_fd_,
2073 "FAIL:could not create zip file, check %s "
2074 "for more details\n",
2075 ds.log_path_.c_str());
2076 } else {
2077 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2078 }
2079 }
2080}
2081
Nandana Dutt4be45d12018-09-26 15:04:23 +01002082
Nandana Dutt58d72e22018-11-16 10:30:48 +00002083static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2084 switch (mode) {
2085 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2086 return "BUGREPORT_FULL";
2087 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2088 return "BUGREPORT_INTERACTIVE";
2089 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2090 return "BUGREPORT_REMOTE";
2091 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2092 return "BUGREPORT_WEAR";
2093 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2094 return "BUGREPORT_TELEPHONY";
2095 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2096 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002097 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2098 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002099 }
2100}
2101
2102static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002103 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002104 switch (mode) {
2105 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Nandana Dutt58d72e22018-11-16 10:30:48 +00002106 options->do_fb = true;
2107 break;
2108 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002109 // Currently, the dumpstate binder is only used by Shell to update progress.
2110 options->do_start_service = true;
2111 options->do_progress_updates = true;
2112 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002113 break;
2114 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002115 options->do_vibrate = false;
2116 options->is_remote_mode = true;
2117 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002118 break;
2119 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002120 options->do_start_service = true;
2121 options->do_progress_updates = true;
2122 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002123 options->do_fb = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002124 break;
2125 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002126 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002127 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002128 break;
2129 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002130 options->wifi_only = true;
2131 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002132 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002133 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002134 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2135 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002136 }
2137}
2138
Nandana Dutt58d72e22018-11-16 10:30:48 +00002139static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2140 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2141 MYLOGI("do_add_date: %d\n", options.do_add_date);
2142 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2143 MYLOGI("use_socket: %d\n", options.use_socket);
2144 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2145 MYLOGI("do_fb: %d\n", options.do_fb);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002146 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2147 MYLOGI("show_header_only: %d\n", options.show_header_only);
2148 MYLOGI("do_start_service: %d\n", options.do_start_service);
2149 MYLOGI("telephony_only: %d\n", options.telephony_only);
2150 MYLOGI("wifi_only: %d\n", options.wifi_only);
2151 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002152 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Abhijeet Kaure370d682019-10-01 16:49:30 +01002153 MYLOGI("bugreport_mode: %s\n", options.bugreport_mode.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002154 MYLOGI("args: %s\n", options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002155}
2156
Nandana Dutt54dbd672019-01-11 12:58:05 +00002157void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2158 const android::base::unique_fd& bugreport_fd_in,
2159 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002160 // In the new API world, date is always added; output is always a zip file.
2161 // TODO(111441001): remove these options once they are obsolete.
2162 do_add_date = true;
2163 do_zip_file = true;
2164
Nandana Dutt54dbd672019-01-11 12:58:05 +00002165 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2166 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2167 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002168
Nandana Dutt58d72e22018-11-16 10:30:48 +00002169 SetOptionsFromMode(bugreport_mode, this);
2170}
2171
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002172Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2173 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002174 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002175 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002176 switch (c) {
2177 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002178 case 'd': do_add_date = true; break;
2179 case 'z': do_zip_file = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002180 case 's': use_socket = true; break;
2181 case 'S': use_control_socket = true; break;
2182 case 'v': show_header_only = true; break;
2183 case 'q': do_vibrate = false; break;
2184 case 'p': do_fb = true; break;
2185 case 'P': do_progress_updates = true; break;
2186 case 'R': is_remote_mode = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002187 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002188 case 'w':
2189 // This was already processed
2190 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002191 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002192 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002193 break;
2194 default:
2195 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002196 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002197 break;
2198 // clang-format on
2199 }
2200 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002201
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002202 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002203 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002204 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002205 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002206 }
2207 }
2208
2209 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2210 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002211
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002212 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002213}
2214
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002215bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002216 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002217 return false;
2218 }
2219
Abhijeet Kaure370d682019-10-01 16:49:30 +01002220 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002221 return false;
2222 }
2223
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002224 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002225 return false;
2226 }
2227
Abhijeet Kaure370d682019-10-01 16:49:30 +01002228 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002229 return false;
2230 }
2231 return true;
2232}
2233
Nandana Dutt197661d2018-11-16 16:40:21 +00002234void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2235 options_ = std::move(options);
2236}
2237
Nandana Duttd2f5f082019-01-18 17:13:52 +00002238Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2239 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002240 if (listener_ != nullptr) {
2241 switch (status) {
2242 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002243 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002244 break;
2245 case Dumpstate::RunStatus::HELP:
2246 break;
2247 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002248 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002249 break;
2250 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002251 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2252 break;
2253 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2254 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2255 break;
2256 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2257 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002258 break;
2259 }
2260 }
2261 return status;
2262}
2263
Nandana Dutt979388e2018-11-30 16:48:55 +00002264/*
2265 * Dumps relevant information to a bugreport based on the given options.
2266 *
2267 * The bugreport can be dumped to a file or streamed to a socket.
2268 *
2269 * How dumping to file works:
2270 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2271 * stderr is redirected a log file.
2272 *
2273 * The temporary bugreport is then populated via printfs, dumping contents of files and
2274 * output of commands to stdout.
2275 *
2276 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2277 * text file.
2278 *
2279 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2280 * gets added to the archive.
2281 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002282 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2283 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002284 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002285Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2286 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002287 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002288 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002289 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002290 return RunStatus::INVALID_INPUT;
2291 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002292 /* set as high priority, and protect from OOM killer */
2293 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002294
Felipe Lemed071c682016-10-20 16:48:00 -07002295 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002296 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002297 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002298 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002299 } else {
2300 /* fallback to kernels <= 2.6.35 */
2301 oom_adj = fopen("/proc/self/oom_adj", "we");
2302 if (oom_adj) {
2303 fputs("-17", oom_adj);
2304 fclose(oom_adj);
2305 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002306 }
2307
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002308 if (version_ == VERSION_DEFAULT) {
2309 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002310 }
2311
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002312 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002313 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002314 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002315 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002316 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002317 }
2318
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002319 if (options_->show_header_only) {
2320 PrintHeader();
2321 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002322 }
2323
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002324 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2325 calling_uid, calling_package.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +01002326 if (CalledByApi()) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002327 // If the output needs to be copied over to the caller's fd, get user consent.
2328 android::String16 package(calling_package.c_str());
2329 CheckUserConsent(calling_uid, package);
2330 }
2331
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002332 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002333 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002334
2335 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002336 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002337 is_redirecting
2338 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2339 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002340 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002341
Felipe Lemed071c682016-10-20 16:48:00 -07002342 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002343 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002344 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002345 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2346
2347 MYLOGI("begin\n");
2348
Sahana Raof35ed432019-07-12 10:47:52 +01002349 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2350 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2351 } else {
2352 // Wake lock will be released automatically on process death
2353 MYLOGD("Wake lock acquired.\n");
2354 }
2355
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002356 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002357
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002358 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002359 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002360 MYLOGI("Starting 'dumpstate' service\n");
2361 android::status_t ret;
2362 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2363 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2364 }
2365 }
2366
Felipe Lemef0292972016-11-22 13:57:05 -08002367 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002368 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2369 }
2370
Abhijeet Kaure370d682019-10-01 16:49:30 +01002371 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s)\n", id_, options_->args.c_str(),
2372 options_->bugreport_mode.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002373
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002374 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002375
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002376 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002377
Christopher Ferrised9354f2014-10-01 17:35:01 -07002378 // If we are going to use a socket, do it as early as possible
2379 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002380 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002381 if (!redirect_to_socket(stdout, "dumpstate")) {
2382 return ERROR;
2383 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002384 }
2385
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002386 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002387 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002388 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002389 if (control_socket_fd_ == -1) {
2390 return ERROR;
2391 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002392 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002393 }
2394
Felipe Leme71bbfc52015-11-23 14:14:51 -08002395 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002396 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002397
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002398 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002399 // clang-format off
2400 std::vector<std::string> am_args = {
2401 "--receiver-permission", "android.permission.DUMP",
2402 };
2403 // clang-format on
2404 // Send STARTED broadcast for apps that listen to bugreport generation events
2405 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002406 if (options_->use_control_socket) {
2407 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002408 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002409 }
2410 }
2411
Nick Kralevichf3599b32016-01-25 15:05:16 -08002412 /* read /proc/cmdline before dropping root */
2413 FILE *cmdline = fopen("/proc/cmdline", "re");
2414 if (cmdline) {
2415 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2416 fclose(cmdline);
2417 }
2418
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002419 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002420 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002421 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002422
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002423 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002424 MYLOGI("taking early screenshot\n");
2425 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002426 }
2427
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002428 if (options_->do_zip_file && zip_file != nullptr) {
2429 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2430 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002431 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002432 }
2433 }
2434
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002435 int dup_stdout_fd;
2436 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002437 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002438 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002439 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002440 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2441 return ERROR;
2442 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002443 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2444 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2445 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002446 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002447
2448 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2449 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002450 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002451 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002452 /* TODO: rather than generating a text file now and zipping it later,
2453 it would be more efficient to redirect stdout to the zip entry
2454 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002455 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2456 return ERROR;
2457 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002458 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002459 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002460 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002461 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002462 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002463
2464 // Don't buffer stdout
2465 setvbuf(stdout, nullptr, _IONBF, 0);
2466
Felipe Leme608385d2016-02-01 10:35:38 -08002467 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2468 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002469 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002470 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002471
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002472 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002473 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002474 DumpstateBoard();
2475 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002476 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002477 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002478 // Dump state for the default case. This also drops root.
Nandana Dutt5c390032019-03-12 10:52:56 +00002479 RunStatus s = DumpstateDefault();
2480 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002481 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002482 HandleUserConsentDenied();
2483 }
2484 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002485 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002486 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002487
Felipe Leme55b42a62015-11-10 17:39:08 -08002488 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002489 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002490 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002491 }
2492
Abhijeet Kaure370d682019-10-01 16:49:30 +01002493 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002494 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002495 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002496 }
2497
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002498 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002499 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002500 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002501 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002502 if (status != Dumpstate::RunStatus::OK &&
2503 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2504 // Do an early return if there were errors. We make an exception for consent
2505 // timing out because it's possible the user got distracted. In this case the
2506 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002507 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002508 return status;
2509 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002510 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002511 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2512 options_->screenshot_fd.get());
2513 if (copy_succeeded) {
2514 android::os::UnlinkAndLogOnError(screenshot_path_);
2515 }
2516 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002517 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2518 MYLOGI(
2519 "Did not receive user consent yet."
2520 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002521 const String16 incidentcompanion("incidentcompanion");
2522 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2523 if (ics != nullptr) {
2524 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2525 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2526 consent_callback_.get());
2527 } else {
2528 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2529 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002530 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002531 }
2532
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002533 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002534 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002535 for (int i = 0; i < 3; i++) {
2536 Vibrate(75);
2537 usleep((75 + 50) * 1000);
2538 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002539 }
2540
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002541 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2542 progress_->GetInitialMax());
2543 progress_->Save();
2544 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002545
Felipe Leme107a05f2016-03-08 15:11:15 -08002546 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002547 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002548 }
2549
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002550 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002551 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002552 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002553 }
2554
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002555 tombstone_data_.clear();
2556 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002557
Nandana Duttd2f5f082019-01-18 17:13:52 +00002558 return (consent_callback_ != nullptr &&
2559 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2560 ? USER_CONSENT_TIMED_OUT
2561 : RunStatus::OK;
2562}
2563
2564void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002565 if (calling_uid == AID_SHELL) {
2566 return;
2567 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002568 consent_callback_ = new ConsentCallback();
2569 const String16 incidentcompanion("incidentcompanion");
2570 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2571 if (ics != nullptr) {
2572 MYLOGD("Checking user consent via incidentcompanion service\n");
2573 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Joe Onorato1c36d752019-03-17 18:26:43 -07002574 calling_uid, calling_package, String16(), String16(),
2575 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002576 } else {
2577 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2578 }
2579}
2580
Nandana Dutt5c390032019-03-12 10:52:56 +00002581bool Dumpstate::IsUserConsentDenied() const {
2582 return ds.consent_callback_ != nullptr &&
2583 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2584}
2585
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002586bool Dumpstate::CalledByApi() const {
2587 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2588}
2589
Nandana Duttd2f5f082019-01-18 17:13:52 +00002590void Dumpstate::CleanupFiles() {
2591 android::os::UnlinkAndLogOnError(tmp_path_);
2592 android::os::UnlinkAndLogOnError(screenshot_path_);
2593 android::os::UnlinkAndLogOnError(path_);
2594}
2595
2596Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2597 MYLOGD("User denied consent; deleting files and returning\n");
2598 CleanupFiles();
2599 return USER_CONSENT_DENIED;
2600}
2601
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002602Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002603 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002604 // user consent (unless the caller is Shell).
2605 UserConsentResult consent_result;
2606 if (calling_uid == AID_SHELL) {
2607 consent_result = UserConsentResult::APPROVED;
2608 } else {
2609 consent_result = consent_callback_->getResult();
2610 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002611 if (consent_result == UserConsentResult::UNAVAILABLE) {
2612 // User has not responded yet.
2613 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2614 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2615 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2616 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2617 sleep(delay_seconds);
2618 }
2619 consent_result = consent_callback_->getResult();
2620 }
2621 if (consent_result == UserConsentResult::DENIED) {
2622 // User has explicitly denied sharing with the app. To be safe delete the
2623 // internal bugreport & tmp files.
2624 return HandleUserConsentDenied();
2625 }
2626 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002627 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2628 if (copy_succeeded) {
2629 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002630 }
2631 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2632 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2633 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2634 // Since we do not have user consent to share the bugreport it does not get
2635 // copied over to the calling app but remains in the internal directory from
2636 // where the user can manually pull it.
2637 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2638 }
2639 // Unknown result; must be a programming error.
2640 MYLOGE("Unknown user consent result:%d\n", consent_result);
2641 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002642}
2643
Nandana Duttf02564e2019-02-15 15:24:24 +00002644Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002645 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2646 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2647 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002648 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002649 // When directly running dumpstate binary, the output is not expected to be written
2650 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002651 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002652
2653 // calling_uid and calling_package are for user consent to share the bugreport with
2654 // an app; they are irrelvant here because bugreport is only written to a local
2655 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002656 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002657 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002658 return status;
2659}
2660
2661/* Main entry point for dumpstate binary. */
2662int run_main(int argc, char* argv[]) {
2663 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002664
2665 switch (status) {
2666 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002667 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002668 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002669 ShowUsage();
2670 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002671 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002672 fprintf(stderr, "Invalid combination of args\n");
2673 ShowUsage();
2674 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002675 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002676 FALLTHROUGH_INTENDED;
2677 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2678 FALLTHROUGH_INTENDED;
2679 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002680 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002681 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002682}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002683
2684// TODO(111441001): Default DumpOptions to sensible values.
2685Dumpstate::Dumpstate(const std::string& version)
2686 : pid_(getpid()),
2687 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01002688 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002689 version_(version),
2690 now_(time(nullptr)) {
2691}
2692
2693Dumpstate& Dumpstate::GetInstance() {
2694 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2695 return singleton_;
2696}
2697
Nandana Dutt8d945c02019-08-14 13:30:07 +01002698DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2699 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002700 if (!title_.empty()) {
2701 started_ = Nanotime();
2702 }
2703}
2704
2705DurationReporter::~DurationReporter() {
2706 if (!title_.empty()) {
2707 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
Nandana Dutt8d945c02019-08-14 13:30:07 +01002708 if (elapsed < .5f && !verbose_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002709 return;
2710 }
2711 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
2712 if (logcat_only_) {
2713 return;
2714 }
2715 // Use "Yoda grammar" to make it easier to grep|sort sections.
2716 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
2717 }
2718}
2719
2720const int32_t Progress::kDefaultMax = 5000;
2721
2722Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2723}
2724
2725Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2726 : Progress(initial_max, growth_factor, "") {
2727 progress_ = progress;
2728}
2729
2730Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2731 : initial_max_(initial_max),
2732 progress_(0),
2733 max_(initial_max),
2734 growth_factor_(growth_factor),
2735 n_runs_(0),
2736 average_max_(0),
2737 path_(path) {
2738 if (!path_.empty()) {
2739 Load();
2740 }
2741}
2742
2743void Progress::Load() {
2744 MYLOGD("Loading stats from %s\n", path_.c_str());
2745 std::string content;
2746 if (!android::base::ReadFileToString(path_, &content)) {
2747 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2748 return;
2749 }
2750 if (content.empty()) {
2751 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2752 return;
2753 }
2754 std::vector<std::string> lines = android::base::Split(content, "\n");
2755
2756 if (lines.size() < 1) {
2757 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2758 (int)lines.size(), max_);
2759 return;
2760 }
2761 char* ptr;
2762 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2763 average_max_ = strtol(ptr, nullptr, 10);
2764 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2765 average_max_ > STATS_MAX_AVERAGE) {
2766 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2767 initial_max_ = Progress::kDefaultMax;
2768 } else {
2769 initial_max_ = average_max_;
2770 }
2771 max_ = initial_max_;
2772
2773 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2774}
2775
2776void Progress::Save() {
2777 int32_t total = n_runs_ * average_max_ + progress_;
2778 int32_t runs = n_runs_ + 1;
2779 int32_t average = floor(((float)total) / runs);
2780 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2781 path_.c_str());
2782 if (path_.empty()) {
2783 return;
2784 }
2785
2786 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2787 if (!android::base::WriteStringToFile(content, path_)) {
2788 MYLOGE("Could not save stats on %s\n", path_.c_str());
2789 }
2790}
2791
2792int32_t Progress::Get() const {
2793 return progress_;
2794}
2795
2796bool Progress::Inc(int32_t delta_sec) {
2797 bool changed = false;
2798 if (delta_sec >= 0) {
2799 progress_ += delta_sec;
2800 if (progress_ > max_) {
2801 int32_t old_max = max_;
2802 max_ = floor((float)progress_ * growth_factor_);
2803 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
2804 changed = true;
2805 }
2806 }
2807 return changed;
2808}
2809
2810int32_t Progress::GetMax() const {
2811 return max_;
2812}
2813
2814int32_t Progress::GetInitialMax() const {
2815 return initial_max_;
2816}
2817
2818void Progress::Dump(int fd, const std::string& prefix) const {
2819 const char* pr = prefix.c_str();
2820 dprintf(fd, "%sprogress: %d\n", pr, progress_);
2821 dprintf(fd, "%smax: %d\n", pr, max_);
2822 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
2823 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
2824 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
2825 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
2826 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
2827}
2828
2829bool Dumpstate::IsZipping() const {
2830 return zip_writer_ != nullptr;
2831}
2832
2833std::string Dumpstate::GetPath(const std::string& suffix) const {
2834 return GetPath(bugreport_internal_dir_, suffix);
2835}
2836
2837std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
2838 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
2839 name_.c_str(), suffix.c_str());
2840}
2841
2842void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
2843 progress_ = std::move(progress);
2844}
2845
2846void for_each_userid(void (*func)(int), const char *header) {
2847 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
2848 "for_each_userid(%s)", header);
2849 DurationReporter duration_reporter(title);
2850 if (PropertiesHelper::IsDryRun()) return;
2851
2852 DIR *d;
2853 struct dirent *de;
2854
2855 if (header) printf("\n------ %s ------\n", header);
2856 func(0);
2857
2858 if (!(d = opendir("/data/system/users"))) {
2859 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
2860 return;
2861 }
2862
2863 while ((de = readdir(d))) {
2864 int userid;
2865 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
2866 continue;
2867 }
2868 func(userid);
2869 }
2870
2871 closedir(d);
2872}
2873
2874static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
2875 DIR *d;
2876 struct dirent *de;
2877
2878 if (!(d = opendir("/proc"))) {
2879 printf("Failed to open /proc (%s)\n", strerror(errno));
2880 return;
2881 }
2882
2883 if (header) printf("\n------ %s ------\n", header);
2884 while ((de = readdir(d))) {
2885 if (ds.IsUserConsentDenied()) {
2886 MYLOGE(
2887 "Returning early because user denied consent to share bugreport with calling app.");
2888 closedir(d);
2889 return;
2890 }
2891 int pid;
2892 int fd;
2893 char cmdpath[255];
2894 char cmdline[255];
2895
2896 if (!(pid = atoi(de->d_name))) {
2897 continue;
2898 }
2899
2900 memset(cmdline, 0, sizeof(cmdline));
2901
2902 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
2903 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2904 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
2905 close(fd);
2906 if (cmdline[0]) {
2907 helper(pid, cmdline, arg);
2908 continue;
2909 }
2910 }
2911
2912 // if no cmdline, a kernel thread has comm
2913 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
2914 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2915 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
2916 close(fd);
2917 if (cmdline[1]) {
2918 cmdline[0] = '[';
2919 size_t len = strcspn(cmdline, "\f\b\r\n");
2920 cmdline[len] = ']';
2921 cmdline[len+1] = '\0';
2922 }
2923 }
2924 if (!cmdline[0]) {
2925 strcpy(cmdline, "N/A");
2926 }
2927 helper(pid, cmdline, arg);
2928 }
2929
2930 closedir(d);
2931}
2932
2933static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
2934 for_each_pid_func *func = (for_each_pid_func*) arg;
2935 func(pid, cmdline);
2936}
2937
2938void for_each_pid(for_each_pid_func func, const char *header) {
2939 std::string title = header == nullptr ? "for_each_pid"
2940 : android::base::StringPrintf("for_each_pid(%s)", header);
2941 DurationReporter duration_reporter(title);
2942 if (PropertiesHelper::IsDryRun()) return;
2943
2944 __for_each_pid(for_each_pid_helper, header, (void *) func);
2945}
2946
2947static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
2948 DIR *d;
2949 struct dirent *de;
2950 char taskpath[255];
2951 for_each_tid_func *func = (for_each_tid_func *) arg;
2952
2953 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
2954
2955 if (!(d = opendir(taskpath))) {
2956 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
2957 return;
2958 }
2959
2960 func(pid, pid, cmdline);
2961
2962 while ((de = readdir(d))) {
2963 if (ds.IsUserConsentDenied()) {
2964 MYLOGE(
2965 "Returning early because user denied consent to share bugreport with calling app.");
2966 closedir(d);
2967 return;
2968 }
2969 int tid;
2970 int fd;
2971 char commpath[255];
2972 char comm[255];
2973
2974 if (!(tid = atoi(de->d_name))) {
2975 continue;
2976 }
2977
2978 if (tid == pid)
2979 continue;
2980
2981 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
2982 memset(comm, 0, sizeof(comm));
2983 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
2984 strcpy(comm, "N/A");
2985 } else {
2986 char *c;
2987 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
2988 close(fd);
2989
2990 c = strrchr(comm, '\n');
2991 if (c) {
2992 *c = '\0';
2993 }
2994 }
2995 func(pid, tid, comm);
2996 }
2997
2998 closedir(d);
2999}
3000
3001void for_each_tid(for_each_tid_func func, const char *header) {
3002 std::string title = header == nullptr ? "for_each_tid"
3003 : android::base::StringPrintf("for_each_tid(%s)", header);
3004 DurationReporter duration_reporter(title);
3005
3006 if (PropertiesHelper::IsDryRun()) return;
3007
3008 __for_each_pid(for_each_tid_helper, header, (void *) func);
3009}
3010
3011void show_wchan(int pid, int tid, const char *name) {
3012 if (PropertiesHelper::IsDryRun()) return;
3013
3014 char path[255];
3015 char buffer[255];
3016 int fd, ret, save_errno;
3017 char name_buffer[255];
3018
3019 memset(buffer, 0, sizeof(buffer));
3020
3021 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3022 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3023 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3024 return;
3025 }
3026
3027 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3028 save_errno = errno;
3029 close(fd);
3030
3031 if (ret < 0) {
3032 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3033 return;
3034 }
3035
3036 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3037 pid == tid ? 0 : 3, "", name);
3038
3039 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3040
3041 return;
3042}
3043
3044// print time in centiseconds
3045static void snprcent(char *buffer, size_t len, size_t spc,
3046 unsigned long long time) {
3047 static long hz; // cache discovered hz
3048
3049 if (hz <= 0) {
3050 hz = sysconf(_SC_CLK_TCK);
3051 if (hz <= 0) {
3052 hz = 1000;
3053 }
3054 }
3055
3056 // convert to centiseconds
3057 time = (time * 100 + (hz / 2)) / hz;
3058
3059 char str[16];
3060
3061 snprintf(str, sizeof(str), " %llu.%02u",
3062 time / 100, (unsigned)(time % 100));
3063 size_t offset = strlen(buffer);
3064 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3065 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3066}
3067
3068// print permille as a percent
3069static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3070 char str[16];
3071
3072 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3073 size_t offset = strlen(buffer);
3074 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3075 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3076}
3077
3078void show_showtime(int pid, const char *name) {
3079 if (PropertiesHelper::IsDryRun()) return;
3080
3081 char path[255];
3082 char buffer[1023];
3083 int fd, ret, save_errno;
3084
3085 memset(buffer, 0, sizeof(buffer));
3086
3087 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3088 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3089 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3090 return;
3091 }
3092
3093 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3094 save_errno = errno;
3095 close(fd);
3096
3097 if (ret < 0) {
3098 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3099 return;
3100 }
3101
3102 // field 14 is utime
3103 // field 15 is stime
3104 // field 42 is iotime
3105 unsigned long long utime = 0, stime = 0, iotime = 0;
3106 if (sscanf(buffer,
3107 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3108 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3109 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3110 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3111 &utime, &stime, &iotime) != 3) {
3112 return;
3113 }
3114
3115 unsigned long long total = utime + stime;
3116 if (!total) {
3117 return;
3118 }
3119
3120 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3121 if (permille > 1000) {
3122 permille = 1000;
3123 }
3124
3125 // try to beautify and stabilize columns at <80 characters
3126 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3127 if ((name[0] != '[') || utime) {
3128 snprcent(buffer, sizeof(buffer), 57, utime);
3129 }
3130 snprcent(buffer, sizeof(buffer), 65, stime);
3131 if ((name[0] != '[') || iotime) {
3132 snprcent(buffer, sizeof(buffer), 73, iotime);
3133 }
3134 if (iotime) {
3135 snprdec(buffer, sizeof(buffer), 79, permille);
3136 }
3137 puts(buffer); // adds a trailing newline
3138
3139 return;
3140}
3141
3142void do_dmesg() {
3143 const char *title = "KERNEL LOG (dmesg)";
3144 DurationReporter duration_reporter(title);
3145 printf("------ %s ------\n", title);
3146
3147 if (PropertiesHelper::IsDryRun()) return;
3148
3149 /* Get size of kernel buffer */
3150 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3151 if (size <= 0) {
3152 printf("Unexpected klogctl return value: %d\n\n", size);
3153 return;
3154 }
3155 char *buf = (char *) malloc(size + 1);
3156 if (buf == nullptr) {
3157 printf("memory allocation failed\n\n");
3158 return;
3159 }
3160 int retval = klogctl(KLOG_READ_ALL, buf, size);
3161 if (retval < 0) {
3162 printf("klogctl failure\n\n");
3163 free(buf);
3164 return;
3165 }
3166 buf[retval] = '\0';
3167 printf("%s\n\n", buf);
3168 free(buf);
3169 return;
3170}
3171
3172void do_showmap(int pid, const char *name) {
3173 char title[255];
3174 char arg[255];
3175
3176 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3177 snprintf(arg, sizeof(arg), "%d", pid);
3178 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3179}
3180
3181int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3182 DurationReporter duration_reporter(title);
3183
3184 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3185
3186 UpdateProgress(WEIGHT_FILE);
3187
3188 return status;
3189}
3190
3191int read_file_as_long(const char *path, long int *output) {
3192 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3193 if (fd < 0) {
3194 int err = errno;
3195 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3196 return -1;
3197 }
3198 char buffer[50];
3199 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3200 if (bytes_read == -1) {
3201 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3202 return -2;
3203 }
3204 if (bytes_read == 0) {
3205 MYLOGE("File %s is empty\n", path);
3206 return -3;
3207 }
3208 *output = atoi(buffer);
3209 return 0;
3210}
3211
3212/* calls skip to gate calling dump_from_fd recursively
3213 * in the specified directory. dump_from_fd defaults to
3214 * dump_file_from_fd above when set to NULL. skip defaults
3215 * to false when set to NULL. dump_from_fd will always be
3216 * called with title NULL.
3217 */
3218int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3219 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3220 DurationReporter duration_reporter(title);
3221 DIR *dirp;
3222 struct dirent *d;
3223 char *newpath = nullptr;
3224 const char *slash = "/";
3225 int retval = 0;
3226
3227 if (!title.empty()) {
3228 printf("------ %s (%s) ------\n", title.c_str(), dir);
3229 }
3230 if (PropertiesHelper::IsDryRun()) return 0;
3231
3232 if (dir[strlen(dir) - 1] == '/') {
3233 ++slash;
3234 }
3235 dirp = opendir(dir);
3236 if (dirp == nullptr) {
3237 retval = -errno;
3238 MYLOGE("%s: %s\n", dir, strerror(errno));
3239 return retval;
3240 }
3241
3242 if (!dump_from_fd) {
3243 dump_from_fd = dump_file_from_fd;
3244 }
3245 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3246 if ((d->d_name[0] == '.')
3247 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3248 || (d->d_name[1] == '\0'))) {
3249 continue;
3250 }
3251 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3252 (d->d_type == DT_DIR) ? "/" : "");
3253 if (!newpath) {
3254 retval = -errno;
3255 continue;
3256 }
3257 if (skip && (*skip)(newpath)) {
3258 continue;
3259 }
3260 if (d->d_type == DT_DIR) {
3261 int ret = dump_files("", newpath, skip, dump_from_fd);
3262 if (ret < 0) {
3263 retval = ret;
3264 }
3265 continue;
3266 }
3267 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3268 if (fd.get() < 0) {
3269 retval = -1;
3270 printf("*** %s: %s\n", newpath, strerror(errno));
3271 continue;
3272 }
3273 (*dump_from_fd)(nullptr, newpath, fd.get());
3274 }
3275 closedir(dirp);
3276 if (!title.empty()) {
3277 printf("\n");
3278 }
3279 return retval;
3280}
3281
3282/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3283 * it's possible to avoid issues where opening the file itself can get
3284 * stuck.
3285 */
3286int dump_file_from_fd(const char *title, const char *path, int fd) {
3287 if (PropertiesHelper::IsDryRun()) return 0;
3288
3289 int flags = fcntl(fd, F_GETFL);
3290 if (flags == -1) {
3291 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3292 return -1;
3293 } else if (!(flags & O_NONBLOCK)) {
3294 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3295 return -1;
3296 }
3297 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3298}
3299
3300int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003301 const CommandOptions& options, bool verbose_duration) {
3302 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003303
3304 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3305
3306 /* TODO: for now we're simplifying the progress calculation by using the
3307 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3308 * where its weight should be much higher proportionally to its timeout.
3309 * Ideally, it should use a options.EstimatedDuration() instead...*/
3310 UpdateProgress(options.Timeout());
3311
3312 return status;
3313}
3314
3315void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3316 const CommandOptions& options, long dumpsysTimeoutMs) {
3317 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3318 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3319 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3320 RunCommand(title, dumpsys, options);
3321}
3322
3323int open_socket(const char *service) {
3324 int s = android_get_control_socket(service);
3325 if (s < 0) {
3326 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3327 return -1;
3328 }
3329 fcntl(s, F_SETFD, FD_CLOEXEC);
3330
3331 // Set backlog to 0 to make sure that queue size will be minimum.
3332 // In Linux, because the minimum queue will be 1, connect() will be blocked
3333 // if the other clients already called connect() and the connection request was not accepted.
3334 if (listen(s, 0) < 0) {
3335 MYLOGE("listen(control socket): %s\n", strerror(errno));
3336 return -1;
3337 }
3338
3339 struct sockaddr addr;
3340 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003341 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003342
3343 // Close socket just after accept(), to make sure that connect() by client will get error
3344 // when the socket is used by the other services.
3345 // There is still a race condition possibility between accept and close, but there is no way
3346 // to close-on-accept atomically.
3347 // See detail; b/123306389#comment25
3348 close(s);
3349
3350 if (fd < 0) {
3351 MYLOGE("accept(control socket): %s\n", strerror(errno));
3352 return -1;
3353 }
3354
3355 return fd;
3356}
3357
3358/* redirect output to a service control socket */
3359bool redirect_to_socket(FILE* redirect, const char* service) {
3360 int fd = open_socket(service);
3361 if (fd == -1) {
3362 return false;
3363 }
3364 fflush(redirect);
3365 // TODO: handle dup2 failure
3366 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3367 close(fd);
3368 return true;
3369}
3370
3371// TODO: should call is_valid_output_file and/or be merged into it.
3372void create_parent_dirs(const char *path) {
3373 char *chp = const_cast<char *> (path);
3374
3375 /* skip initial slash */
3376 if (chp[0] == '/')
3377 chp++;
3378
3379 /* create leading directories, if necessary */
3380 struct stat dir_stat;
3381 while (chp && chp[0]) {
3382 chp = strchr(chp, '/');
3383 if (chp) {
3384 *chp = 0;
3385 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3386 MYLOGI("Creating directory %s\n", path);
3387 if (mkdir(path, 0770)) { /* drwxrwx--- */
3388 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3389 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3390 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3391 }
3392 }
3393 *chp++ = '/';
3394 }
3395 }
3396}
3397
3398bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3399 create_parent_dirs(path);
3400
3401 int fd = TEMP_FAILURE_RETRY(open(path,
3402 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3403 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3404 if (fd < 0) {
3405 MYLOGE("%s: %s\n", path, strerror(errno));
3406 return false;
3407 }
3408
3409 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3410 close(fd);
3411 return true;
3412}
3413
3414bool redirect_to_file(FILE* redirect, char* path) {
3415 return _redirect_to_file(redirect, path, O_TRUNC);
3416}
3417
3418bool redirect_to_existing_file(FILE* redirect, char* path) {
3419 return _redirect_to_file(redirect, path, O_APPEND);
3420}
3421
3422void dump_route_tables() {
3423 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3424 if (PropertiesHelper::IsDryRun()) return;
3425 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3426 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3427 FILE* fp = fopen(RT_TABLES_PATH, "re");
3428 if (!fp) {
3429 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3430 return;
3431 }
3432 char table[16];
3433 // Each line has an integer (the table number), a space, and a string (the table name). We only
3434 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3435 // Add a fixed max limit so this doesn't go awry.
3436 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3437 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3438 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3439 }
3440 fclose(fp);
3441}
3442
3443// TODO: make this function thread safe if sections are generated in parallel.
3444void Dumpstate::UpdateProgress(int32_t delta_sec) {
3445 if (progress_ == nullptr) {
3446 MYLOGE("UpdateProgress: progress_ not set\n");
3447 return;
3448 }
3449
3450 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01003451 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003452
3453 // ...but only notifiy listeners when necessary.
3454 if (!options_->do_progress_updates) return;
3455
3456 int progress = progress_->Get();
3457 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01003458 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003459
Nandana Dutt402a8392019-06-14 14:25:13 +01003460 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003461 return;
3462 }
Nandana Dutt402a8392019-06-14 14:25:13 +01003463 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003464
3465 if (control_socket_fd_ >= 0) {
3466 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3467 fsync(control_socket_fd_);
3468 }
3469
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003470 if (listener_ != nullptr) {
3471 if (percent % 5 == 0) {
3472 // We don't want to spam logcat, so only log multiples of 5.
3473 MYLOGD("Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(), progress, max,
3474 percent);
3475 } else {
3476 // stderr is ignored on normal invocations, but useful when calling
3477 // /system/bin/dumpstate directly for debuggging.
3478 fprintf(stderr, "Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(),
3479 progress, max, percent);
3480 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003481
3482 listener_->onProgress(percent);
3483 }
3484}
3485
3486void Dumpstate::TakeScreenshot(const std::string& path) {
3487 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3488 int status =
3489 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3490 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3491 if (status == 0) {
3492 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3493 } else {
3494 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3495 }
3496}
3497
3498bool is_dir(const char* pathname) {
3499 struct stat info;
3500 if (stat(pathname, &info) == -1) {
3501 return false;
3502 }
3503 return S_ISDIR(info.st_mode);
3504}
3505
3506time_t get_mtime(int fd, time_t default_mtime) {
3507 struct stat info;
3508 if (fstat(fd, &info) == -1) {
3509 return default_mtime;
3510 }
3511 return info.st_mtime;
3512}