blob: d705fa80b578919aedbffe79fa36d90129f90c0a [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080031#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070032#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <sys/resource.h>
34#include <sys/stat.h>
35#include <sys/time.h>
36#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010037#include <signal.h>
38#include <stdarg.h>
39#include <string.h>
40#include <sys/capability.h>
41#include <sys/inotify.h>
42#include <sys/klog.h>
43#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070044#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045
46#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070047#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000048#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <functional>
50#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010051#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070052#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <regex>
54#include <set>
55#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070056#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010057#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070058
Felipe Leme96c2bbb2016-09-26 09:21:21 -070059#include <android-base/file.h>
60#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070061#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080062#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070063#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070064#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010065#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080066#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080067#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000068#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010069#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080070#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070071#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010072#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000073#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080074#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010076#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080077#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010078#include <log/log.h>
Felipe Leme75876a22016-10-27 16:31:27 -070079#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070080#include <private/android_filesystem_config.h>
81#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070083#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080084#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070085#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070086#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080087
Steven Morelandcb7ef822016-11-29 13:20:37 -080088using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080089using ::std::literals::chrono_literals::operator""ms;
90using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080091
Felipe Leme47e9be22016-12-21 15:37:07 -080092// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080093using android::defaultServiceManager;
94using android::Dumpsys;
95using android::INVALID_OPERATION;
96using android::IServiceManager;
97using android::OK;
98using android::sp;
99using android::status_t;
100using android::String16;
101using android::String8;
102using android::TIMED_OUT;
103using android::UNKNOWN_ERROR;
104using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000105using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000106using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800107using android::os::dumpstate::CommandOptions;
108using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -0800109using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -0800110
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100111// Keep in sync with
112// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
113static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
114
115/* Most simple commands have 10 as timeout, so 5 is a good estimate */
116static const int32_t WEIGHT_FILE = 5;
117
118// TODO: temporary variables and functions used during C++ refactoring
119static Dumpstate& ds = Dumpstate::GetInstance();
120static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100121 const CommandOptions& options = CommandOptions::DEFAULT,
122 bool verbose_duration = false) {
123 return ds.RunCommand(title, full_command, options, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100124}
125
126// Reasonable value for max stats.
127static const int STATS_MAX_N_RUNS = 1000;
128static const long STATS_MAX_AVERAGE = 100000;
129
130CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
131
Nandana Duttd2f5f082019-01-18 17:13:52 +0000132typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
133
Colin Crossf45fa6b2012-03-26 12:38:26 -0700134/* read before root is shed */
135static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700136static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000137static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700138
Felipe Leme1d486fe2016-10-14 18:06:47 -0700139// TODO: variables and functions below should be part of dumpstate object
140
Felipe Leme635ca312016-01-05 14:23:02 -0800141static std::set<std::string> mount_points;
142void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800143
Todd Poynor2a83daa2013-11-22 15:44:22 -0800144#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700145#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700146#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800147
Felipe Lemee82a27d2016-01-05 13:35:44 -0800148#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700149#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700150#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700151#define LOGPERSIST_DATA_DIR "/data/misc/logd"
David Brazdild2991962016-06-03 14:40:44 +0100152#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
153#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800154#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900155#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800156#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700157#define OTA_METADATA_DIR "/metadata/ota"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700158
Narayan Kamath8f788292017-05-25 13:20:39 +0100159// TODO(narayan): Since this information has to be kept in sync
160// with tombstoned, we should just put it in a common header.
161//
162// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100163static const std::string TOMBSTONE_DIR = "/data/tombstones/";
164static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
165static const std::string ANR_DIR = "/data/anr/";
166static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700167
Felipe Lemee844a9d2016-09-21 15:01:39 -0700168// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000169
Nandana Dutt5c390032019-03-12 10:52:56 +0000170#define RETURN_IF_USER_DENIED_CONSENT() \
171 if (ds.IsUserConsentDenied()) { \
172 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
173 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
174 }
175
176// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
177// if consent is found to be denied.
178#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
179 RETURN_IF_USER_DENIED_CONSENT(); \
180 func_ptr(__VA_ARGS__); \
181 RETURN_IF_USER_DENIED_CONSENT();
182
Sahana Raof35ed432019-07-12 10:47:52 +0100183static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
184
Nandana Dutt979388e2018-11-30 16:48:55 +0000185namespace android {
186namespace os {
187namespace {
188
189static int Open(std::string path, int flags, mode_t mode = 0) {
190 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
191 if (fd == -1) {
192 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
193 }
194 return fd;
195}
196
Nandana Dutt979388e2018-11-30 16:48:55 +0000197
198static int OpenForRead(std::string path) {
199 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
200}
201
202bool CopyFile(int in_fd, int out_fd) {
203 char buf[4096];
204 ssize_t byte_count;
205 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
206 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
207 return false;
208 }
209 }
210 return (byte_count != -1);
211}
212
213static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000214 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000215
216 // Obtain a handle to the source file.
217 android::base::unique_fd in_fd(OpenForRead(input_file));
218 if (out_fd != -1 && in_fd.get() != -1) {
219 if (CopyFile(in_fd.get(), out_fd)) {
220 return true;
221 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000222 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000223 }
224 return false;
225}
226
Nandana Duttd2f5f082019-01-18 17:13:52 +0000227static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000228 if (unlink(file.c_str())) {
229 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000230 return false;
231 }
232 return true;
233}
Nandana Dutt979388e2018-11-30 16:48:55 +0000234
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000235static bool IsFileEmpty(const std::string& file_path) {
236 std::ifstream file(file_path, std::ios::binary | std::ios::ate);
237 if(file.bad()) {
238 MYLOGE("Cannot open file: %s\n", file_path.c_str());
239 return true;
240 }
241 return file.tellg() <= 0;
242}
243
Nikita Ioffea325a572019-05-16 19:49:47 +0100244int64_t GetModuleMetadataVersion() {
245 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
246 if (binder == nullptr) {
247 MYLOGE("Failed to retrieve package_native service");
248 return 0L;
249 }
250 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
251 std::string package_name;
252 auto status = package_service->getModuleMetadataPackageName(&package_name);
253 if (!status.isOk()) {
254 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
255 return 0L;
256 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100257 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100258 int64_t version_code;
259 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
260 &version_code);
261 if (!status.isOk()) {
262 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
263 return 0L;
264 }
265 return version_code;
266}
267
Nandana Dutt979388e2018-11-30 16:48:55 +0000268} // namespace
269} // namespace os
270} // namespace android
271
Felipe Leme678727a2016-09-21 17:22:11 -0700272static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800273 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800274 long dumpsysTimeoutMs = 0) {
275 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700276}
277static int DumpFile(const std::string& title, const std::string& path) {
278 return ds.DumpFile(title, path);
279}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800280
Felipe Lemee844a9d2016-09-21 15:01:39 -0700281// Relative directory (inside the zip) for all files copied as-is into the bugreport.
282static const std::string ZIP_ROOT_DIR = "FS";
283
Vishnu Naire97d6122018-01-18 13:58:56 -0800284static const std::string kProtoPath = "proto/";
285static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700286static const std::string kDumpstateBoardFiles[] = {
287 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700288 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700289};
290static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
291
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700292static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700293static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700294static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700295static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
296static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700297
Felipe Lemef0292972016-11-22 13:57:05 -0800298static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
299
Narayan Kamath8f788292017-05-25 13:20:39 +0100300/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100301 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
302 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
303 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100304 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700305static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
306 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700307 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100308 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
309
Narayan Kamathbd863722017-06-01 18:50:12 +0100310 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100311
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700312 if (dump_dir == nullptr) {
313 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700314 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700315 }
316
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700317 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100318 struct dirent* entry = nullptr;
319 while ((entry = readdir(dump_dir.get()))) {
320 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100321 continue;
322 }
323
Narayan Kamathbd863722017-06-01 18:50:12 +0100324 const std::string base_name(entry->d_name);
325 if (base_name.find(file_prefix) != 0) {
326 continue;
327 }
328
329 const std::string abs_path = dir_path + base_name;
330 android::base::unique_fd fd(
331 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
332 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700333 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100334 break;
335 }
336
337 struct stat st = {};
338 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700339 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100340 continue;
341 }
342
Narayan Kamath3f31b632018-02-22 19:42:36 +0000343 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100344 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100345 continue;
346 }
347
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700348 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700349 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100350
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700351 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100352}
353
Narayan Kamathbd863722017-06-01 18:50:12 +0100354static bool AddDumps(const std::vector<DumpData>::const_iterator start,
355 const std::vector<DumpData>::const_iterator end,
356 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100357 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100358 for (auto it = start; it != end; ++it) {
359 const std::string& name = it->name;
360 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100361 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100362
363 // Seek to the beginning of the file before dumping any data. A given
364 // DumpData entry might be dumped multiple times in the report.
365 //
366 // For example, the most recent ANR entry is dumped to the body of the
367 // main entry and it also shows up as a separate entry in the bugreport
368 // ZIP file.
369 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
370 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
371 strerror(errno));
372 }
373
Narayan Kamath8f788292017-05-25 13:20:39 +0100374 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800375 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100376 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100377 }
378 } else {
379 dump_file_from_fd(type_name, name.c_str(), fd);
380 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100381 }
382
383 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700384}
385
Felipe Leme635ca312016-01-05 14:23:02 -0800386// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700387void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800388 char path[PATH_MAX];
389
390 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
391 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700392 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800393 char linkname[PATH_MAX];
394 ssize_t r = readlink(path, linkname, PATH_MAX);
395 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800396 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800397 return;
398 }
399 linkname[r] = '\0';
400
401 if (mount_points.find(linkname) == mount_points.end()) {
402 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700403 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700404 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800405 mount_points.insert(linkname);
406 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800407 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800408 }
409 }
410}
411
412void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700413 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700414 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800415 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800416 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700417 for_each_pid(do_mountinfo, nullptr);
418 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800419}
420
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700421static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
422{
423 DIR *d;
424 struct dirent *de;
425 char path[PATH_MAX];
426
427 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700428 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700429 return;
430 }
431
432 while ((de = readdir(d))) {
433 if (de->d_type != DT_LNK) {
434 continue;
435 }
436 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700437 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700438 }
439
440 closedir(d);
441}
442
Mark Salyzyn326842f2015-04-30 09:49:41 -0700443static bool skip_not_stat(const char *path) {
444 static const char stat[] = "/stat";
445 size_t len = strlen(path);
446 if (path[len - 1] == '/') { /* Directory? */
447 return false;
448 }
449 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
450}
451
Felipe Leme4c2d6632016-09-28 14:32:00 -0700452static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800453 return false;
454}
455
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700456unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700457
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800458//
459// stat offsets
460// Name units description
461// ---- ----- -----------
462// read I/Os requests number of read I/Os processed
463#define __STAT_READ_IOS 0
464// read merges requests number of read I/Os merged with in-queue I/O
465#define __STAT_READ_MERGES 1
466// read sectors sectors number of sectors read
467#define __STAT_READ_SECTORS 2
468// read ticks milliseconds total wait time for read requests
469#define __STAT_READ_TICKS 3
470// write I/Os requests number of write I/Os processed
471#define __STAT_WRITE_IOS 4
472// write merges requests number of write I/Os merged with in-queue I/O
473#define __STAT_WRITE_MERGES 5
474// write sectors sectors number of sectors written
475#define __STAT_WRITE_SECTORS 6
476// write ticks milliseconds total wait time for write requests
477#define __STAT_WRITE_TICKS 7
478// in_flight requests number of I/Os currently in flight
479#define __STAT_IN_FLIGHT 8
480// io_ticks milliseconds total time this block device has been active
481#define __STAT_IO_TICKS 9
482// time_in_queue milliseconds total wait time for all requests
483#define __STAT_IN_QUEUE 10
484#define __STAT_NUMBER_FIELD 11
485//
486// read I/Os, write I/Os
487// =====================
488//
489// These values increment when an I/O request completes.
490//
491// read merges, write merges
492// =========================
493//
494// These values increment when an I/O request is merged with an
495// already-queued I/O request.
496//
497// read sectors, write sectors
498// ===========================
499//
500// These values count the number of sectors read from or written to this
501// block device. The "sectors" in question are the standard UNIX 512-byte
502// sectors, not any device- or filesystem-specific block size. The
503// counters are incremented when the I/O completes.
504#define SECTOR_SIZE 512
505//
506// read ticks, write ticks
507// =======================
508//
509// These values count the number of milliseconds that I/O requests have
510// waited on this block device. If there are multiple I/O requests waiting,
511// these values will increase at a rate greater than 1000/second; for
512// example, if 60 read requests wait for an average of 30 ms, the read_ticks
513// field will increase by 60*30 = 1800.
514//
515// in_flight
516// =========
517//
518// This value counts the number of I/O requests that have been issued to
519// the device driver but have not yet completed. It does not include I/O
520// requests that are in the queue but not yet issued to the device driver.
521//
522// io_ticks
523// ========
524//
525// This value counts the number of milliseconds during which the device has
526// had I/O requests queued.
527//
528// time_in_queue
529// =============
530//
531// This value counts the number of milliseconds that I/O requests have waited
532// on this block device. If there are multiple I/O requests waiting, this
533// value will increase as the product of the number of milliseconds times the
534// number of requests waiting (see "read ticks" above for an example).
535#define S_TO_MS 1000
536//
537
Mark Salyzyn326842f2015-04-30 09:49:41 -0700538static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800539 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700540 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700541 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700542 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700543 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700544 getline(&buffer, &i, fp);
545 fclose(fp);
546 if (!buffer) {
547 return -errno;
548 }
549 i = strlen(buffer);
550 while ((i > 0) && (buffer[i - 1] == '\n')) {
551 buffer[--i] = '\0';
552 }
553 if (!*buffer) {
554 free(buffer);
555 return 0;
556 }
557 z = true;
558 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800559 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700560 if (fields[i] != 0) {
561 z = false;
562 }
563 }
564 if (z) { /* never accessed */
565 free(buffer);
566 return 0;
567 }
568
Wei Wang509bb5d2017-06-09 14:42:12 -0700569 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
570 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700571 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700572
573 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
574 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
575 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700576 free(buffer);
577
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800578 if (fields[__STAT_IO_TICKS]) {
579 unsigned long read_perf = 0;
580 unsigned long read_ios = 0;
581 if (fields[__STAT_READ_TICKS]) {
582 unsigned long long divisor = fields[__STAT_READ_TICKS]
583 * fields[__STAT_IO_TICKS];
584 read_perf = ((unsigned long long)SECTOR_SIZE
585 * fields[__STAT_READ_SECTORS]
586 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
587 / divisor;
588 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
589 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
590 / divisor;
591 }
592
593 unsigned long write_perf = 0;
594 unsigned long write_ios = 0;
595 if (fields[__STAT_WRITE_TICKS]) {
596 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
597 * fields[__STAT_IO_TICKS];
598 write_perf = ((unsigned long long)SECTOR_SIZE
599 * fields[__STAT_WRITE_SECTORS]
600 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
601 / divisor;
602 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
603 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
604 / divisor;
605 }
606
607 unsigned queue = (fields[__STAT_IN_QUEUE]
608 + (fields[__STAT_IO_TICKS] >> 1))
609 / fields[__STAT_IO_TICKS];
610
611 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700612 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 -0800613 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700614 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 -0800615 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800616 }
617
618 /* bugreport timeout factor adjustment */
619 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
620 worst_write_perf = write_perf;
621 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700622 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700623 return 0;
624}
625
Yao Chenbe3bbc12018-01-17 16:31:10 -0800626static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
627
628/* timeout in ms to read a list of buffers */
629static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
630 unsigned long timeout_ms = 0;
631 for (const auto& buffer : buffers) {
632 log_id_t id = android_name_to_log_id(buffer.c_str());
633 unsigned long property_size = __android_logger_get_buffer_size(id);
634 /* Engineering margin is ten-fold our guess */
635 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
636 }
637 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700638}
639
Nandana Duttd2f5f082019-01-18 17:13:52 +0000640Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
641}
642
643android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
644 std::lock_guard<std::mutex> lock(lock_);
645 result_ = APPROVED;
646 MYLOGD("User approved consent to share bugreport\n");
647 return android::binder::Status::ok();
648}
649
650android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
651 std::lock_guard<std::mutex> lock(lock_);
652 result_ = DENIED;
653 MYLOGW("User denied consent to share bugreport\n");
654 return android::binder::Status::ok();
655}
656
657UserConsentResult Dumpstate::ConsentCallback::getResult() {
658 std::lock_guard<std::mutex> lock(lock_);
659 return result_;
660}
661
662uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
663 return Nanotime() - start_time_;
664}
665
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700666void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700667 std::string build, fingerprint, radio, bootloader, network;
668 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700669
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700670 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
671 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700672 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
673 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
674 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700675 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700676
Felipe Lemed8b94e52016-12-08 10:21:44 -0800677 printf("========================================================\n");
678 printf("== dumpstate: %s\n", date);
679 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700680
Felipe Lemed8b94e52016-12-08 10:21:44 -0800681 printf("\n");
682 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700683 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800684 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
685 printf("Bootloader: %s\n", bootloader.c_str());
686 printf("Radio: %s\n", radio.c_str());
687 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100688 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
689 if (module_metadata_version != 0) {
690 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
691 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700692
Felipe Lemed8b94e52016-12-08 10:21:44 -0800693 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800694 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800695 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800696 printf("Uptime: ");
697 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
698 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800699 printf("Bugreport format version: %s\n", version_.c_str());
700 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s extra_options=%s\n", id_, pid_,
Nandana Dutt5fb117b2018-09-27 09:23:36 +0100701 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800702 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800703}
704
Felipe Leme24b66ee2016-06-16 10:55:26 -0700705// List of file extensions that can cause a zip file attachment to be rejected by some email
706// service providers.
707static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
708 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
709 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
710 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
711};
712
Vishnu Naire97d6122018-01-18 13:58:56 -0800713status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
714 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700715 if (!IsZipping()) {
716 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
717 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800718 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800719 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700720 std::string valid_name = entry_name;
721
722 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700723 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700724 if (idx != std::string::npos) {
725 std::string extension = entry_name.substr(idx);
726 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
727 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
728 valid_name = entry_name + ".renamed";
729 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
730 }
731 }
732
Felipe Leme6fe9db62016-02-12 09:04:16 -0800733 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
734 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700735 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
736 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700737 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700738 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700739 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800740 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800741 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000742 bool finished_entry = false;
743 auto finish_entry = [this, &finished_entry] {
744 if (!finished_entry) {
745 // This should only be called when we're going to return an earlier error,
746 // which would've been logged. This may imply the file is already corrupt
747 // and any further logging from FinishEntry is more likely to mislead than
748 // not.
749 this->zip_writer_->FinishEntry();
750 }
751 };
752 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800753 auto start = std::chrono::steady_clock::now();
754 auto end = start + timeout;
755 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800756
Felipe Leme770410d2016-01-26 17:07:14 -0800757 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800758 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800759 if (timeout.count() > 0) {
760 // lambda to recalculate the timeout.
761 auto time_left_ms = [end]() {
762 auto now = std::chrono::steady_clock::now();
763 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
764 return std::max(diff.count(), 0LL);
765 };
766
767 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
768 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000769 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
770 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800771 return -errno;
772 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000773 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800774 entry_name.c_str(), strerror(errno), timeout.count());
775 return TIMED_OUT;
776 }
777 }
778
Zach Riggle22200402016-08-18 01:01:24 -0400779 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800780 if (bytes_read == 0) {
781 break;
782 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800783 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800784 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800785 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700786 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800787 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700788 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800789 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800790 }
791 }
792
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700793 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000794 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700795 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700796 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800797 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800798 }
799
Vishnu Naire97d6122018-01-18 13:58:56 -0800800 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800801}
802
Felipe Leme1d486fe2016-10-14 18:06:47 -0700803bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
804 android::base::unique_fd fd(
805 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700806 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800807 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800808 return false;
809 }
810
Vishnu Naire97d6122018-01-18 13:58:56 -0800811 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800812}
813
814/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700815static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800816 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800817}
818
Felipe Leme1d486fe2016-10-14 18:06:47 -0700819void Dumpstate::AddDir(const std::string& dir, bool recursive) {
820 if (!IsZipping()) {
821 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800822 return;
823 }
Felipe Leme678727a2016-09-21 17:22:11 -0700824 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800825 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700826 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800827}
828
Felipe Leme1d486fe2016-10-14 18:06:47 -0700829bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
830 if (!IsZipping()) {
831 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
832 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800833 return false;
834 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800835 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700836 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700837 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700838 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700839 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800840 return false;
841 }
842
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700843 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700844 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700845 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700846 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800847 return false;
848 }
849
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700850 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700851 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700852 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800853 return false;
854 }
855
856 return true;
857}
858
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800859static void DoKmsg() {
860 struct stat st;
861 if (!stat(PSTORE_LAST_KMSG, &st)) {
862 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
863 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
864 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
865 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
866 } else {
867 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
868 DumpFile("LAST KMSG", "/proc/last_kmsg");
869 }
870}
871
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800872static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800873 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800874 RunCommand(
875 "KERNEL LOG",
876 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
877 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
878}
879
Nandana Duttdb379fa2019-10-09 16:54:41 +0100880static void DoSystemLogcat(time_t since) {
881 char since_str[80];
882 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
883
884 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
885 RunCommand("SYSTEM LOG",
886 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
887 since_str},
888 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
889}
890
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800891static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800892 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800893 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
894 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800895 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100896 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800897 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
898 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800899 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800900 RunCommand(
901 "EVENT LOG",
902 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100903 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800904 timeout_ms = logcat_timeout({"stats"});
905 RunCommand(
906 "STATS LOG",
907 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100908 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800909 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800910 RunCommand(
911 "RADIO LOG",
912 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100913 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800914
915 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
916
917 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800918 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
919 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800920}
921
Mike Ma5c267872019-08-21 11:31:34 -0700922static void DumpIncidentReport() {
923 if (!ds.IsZipping()) {
924 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
925 return;
926 }
927 DurationReporter duration_reporter("INCIDENT REPORT");
928 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
929 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
930 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
931 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
932 if (fd < 0) {
933 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
934 return;
935 }
936 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
937 bool empty = 0 == lseek(fd, 0, SEEK_END);
938 if (!empty) {
939 // Use a different name from "incident.proto"
940 // /proto/incident.proto is reserved for incident service dump
941 // i.e. metadata for debugging.
942 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
943 }
944 unlink(path.c_str());
945}
946
Jayachandran Ca94c7172017-06-10 15:08:12 -0700947static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700948 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
949 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900950 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700951 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900952 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
953 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
954 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
955 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700956}
957
David Andersond9ba4752018-12-11 18:26:59 -0800958static void DumpDynamicPartitionInfo() {
959 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
960 return;
961 }
962
963 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -0700964 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -0800965}
966
Narayan Kamath8f788292017-05-25 13:20:39 +0100967static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
968 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
969 anr_traces_dir.c_str());
970
971 // If we're here, dump_traces_path will always be a temporary file
972 // (created with mkostemp or similar) that contains dumps taken earlier
973 // on in the process.
974 if (dump_traces_path != nullptr) {
975 if (add_to_zip) {
976 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
977 } else {
978 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
979 dump_traces_path);
980 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
981 }
982
983 const int ret = unlink(dump_traces_path);
984 if (ret == -1) {
985 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
986 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700987 }
988 }
989
Narayan Kamathbd863722017-06-01 18:50:12 +0100990 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700991 if (ds.anr_data_.size() > 0) {
992 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100993 "VM TRACES AT LAST ANR", add_to_zip);
994
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100995 // The "last" ANR will always be included as separate entry in the zip file. In addition,
996 // it will be present in the body of the main entry if |add_to_zip| == false.
997 //
998 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700999 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001000 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001001 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001002 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1003 }
1004}
1005
1006static void AddAnrTraceFiles() {
1007 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1008
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001009 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001010
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001011 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001012
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001013 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1014
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001015 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001016 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001017 int i = 0;
1018 while (true) {
1019 const std::string slow_trace_path =
1020 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1021 if (stat(slow_trace_path.c_str(), &st)) {
1022 // No traces file at this index, done with the files.
1023 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001024 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001025 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1026 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001027 }
1028}
1029
Wei Wang509bb5d2017-06-09 14:42:12 -07001030static void DumpBlockStatFiles() {
1031 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001032
Wei Wang1dc1ef52017-06-12 11:28:37 -07001033 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1034
1035 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001036 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1037 return;
1038 }
1039
1040 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001041 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001042 if ((d->d_name[0] == '.')
1043 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1044 || (d->d_name[1] == '\0'))) {
1045 continue;
1046 }
1047 const std::string new_path =
1048 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1049 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1050 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1051 printf("\n");
1052 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001053 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001054}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001055
1056static void DumpPacketStats() {
1057 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1058 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1059 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1060 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1061 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1062}
1063
1064static void DumpIpAddrAndRules() {
1065 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1066 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1067 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1068 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1069 RunCommand("IP RULES", {"ip", "rule", "show"});
1070 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1071}
1072
Nandana Dutt5c390032019-03-12 10:52:56 +00001073static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1074 std::chrono::milliseconds timeout,
1075 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001076 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001077 sp<android::IServiceManager> sm = defaultServiceManager();
1078 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001079 Vector<String16> args;
1080 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001081 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1082 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001083 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001084 std::string path(title);
1085 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001086 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001087 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001088 if (status == OK) {
1089 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1090 std::chrono::duration<double> elapsed_seconds;
1091 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1092 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001093 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1094 bool dump_complete = (status == OK);
1095 dumpsys.stopDumpThread(dump_complete);
1096 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001097
1098 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1099 std::chrono::steady_clock::now() - start);
1100 if (elapsed_duration > timeout) {
1101 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1102 elapsed_duration.count());
1103 break;
1104 }
1105 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001106 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001107}
1108
Vishnu Nair64afc022018-02-01 15:29:34 -08001109static void RunDumpsysText(const std::string& title, int priority,
1110 std::chrono::milliseconds timeout,
1111 std::chrono::milliseconds service_timeout) {
1112 DurationReporter duration_reporter(title);
1113 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1114 fsync(STDOUT_FILENO);
1115 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1116}
1117
1118/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001119static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1120 std::chrono::milliseconds timeout,
1121 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001122 DurationReporter duration_reporter(title);
1123 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1124 fsync(STDOUT_FILENO);
1125 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1126 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001127
1128 RETURN_IF_USER_DENIED_CONSENT();
1129
1130 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1131 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001132}
1133
Nandana Dutt5c390032019-03-12 10:52:56 +00001134static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1135 std::chrono::milliseconds timeout,
1136 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001137 if (!ds.IsZipping()) {
1138 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001139 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001140 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001141 sp<android::IServiceManager> sm = defaultServiceManager();
1142 Dumpsys dumpsys(sm.get());
1143 Vector<String16> args;
1144 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1145 DurationReporter duration_reporter(title);
1146
1147 auto start = std::chrono::steady_clock::now();
1148 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1149 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001150 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001151 std::string path(kProtoPath);
1152 path.append(String8(service).c_str());
1153 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1154 path.append("_CRITICAL");
1155 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1156 path.append("_HIGH");
1157 }
1158 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001159 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001160 if (status == OK) {
1161 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1162 bool dumpTerminated = (status == OK);
1163 dumpsys.stopDumpThread(dumpTerminated);
1164 }
1165 ZipWriter::FileEntry file_entry;
1166 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001167
1168 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1169 std::chrono::steady_clock::now() - start);
1170 if (elapsed_duration > timeout) {
1171 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1172 elapsed_duration.count());
1173 break;
1174 }
1175 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001176 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001177}
1178
Nandana Dutta7db6342018-11-21 14:53:34 +00001179// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001180static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001181 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1182 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001183
1184 RETURN_IF_USER_DENIED_CONSENT();
1185
1186 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1187 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001188}
1189
1190// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001191static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001192 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1193 // high priority. Reduce timeout once they are able to dump in a shorter time or
1194 // moved to a parallel task.
1195 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1196 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001197
1198 RETURN_IF_USER_DENIED_CONSENT();
1199
1200 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1201 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001202}
1203
1204// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001205static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001206 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001207
1208 RETURN_IF_USER_DENIED_CONSENT();
1209
1210 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1211 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001212}
1213
Steven Moreland44cd9482018-01-04 16:24:13 -08001214static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001215 if (!ds.IsZipping()) {
1216 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1217 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1218 return;
1219 }
1220 DurationReporter duration_reporter("DUMP HALS");
1221 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001222 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001223
Steven Moreland44cd9482018-01-04 16:24:13 -08001224 using android::hidl::manager::V1_0::IServiceManager;
1225 using android::hardware::defaultServiceManager;
1226
1227 sp<IServiceManager> sm = defaultServiceManager();
1228 if (sm == nullptr) {
1229 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1230 return;
1231 }
1232
1233 auto ret = sm->list([&](const auto& interfaces) {
1234 for (const std::string& interface : interfaces) {
1235 std::string cleanName = interface;
1236 std::replace_if(cleanName.begin(),
1237 cleanName.end(),
1238 [](char c) {
1239 return !isalnum(c) &&
1240 std::string("@-_:.").find(c) == std::string::npos;
1241 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001242 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001243
1244 {
1245 auto fd = android::base::unique_fd(
1246 TEMP_FAILURE_RETRY(open(path.c_str(),
1247 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1248 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1249 if (fd < 0) {
1250 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1251 continue;
1252 }
1253 RunCommandToFd(fd,
1254 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001255 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001256 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1257
1258 bool empty = 0 == lseek(fd, 0, SEEK_END);
1259 if (!empty) {
1260 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1261 }
1262 }
1263
1264 unlink(path.c_str());
1265 }
1266 });
1267
1268 if (!ret.isOk()) {
1269 MYLOGE("Could not list hals from hwservicemanager.\n");
1270 }
1271}
1272
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001273static void DumpExternalFragmentationInfo() {
1274 struct stat st;
1275 if (stat("/proc/buddyinfo", &st) != 0) {
1276 MYLOGE("Unable to dump external fragmentation info\n");
1277 return;
1278 }
1279
1280 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1281 std::ifstream ifs("/proc/buddyinfo");
1282 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1283 for (std::string line; std::getline(ifs, line);) {
1284 std::smatch match_results;
1285 if (std::regex_match(line, match_results, unusable_index_regex)) {
1286 std::stringstream free_pages(std::string{match_results[3]});
1287 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1288 std::istream_iterator<int>());
1289
1290 int total_free_pages = 0;
1291 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1292 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1293 }
1294
1295 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1296 match_results[2].str().c_str());
1297
1298 int usable_free_pages = total_free_pages;
1299 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1300 auto unusable_index = (total_free_pages - usable_free_pages) /
1301 static_cast<double>(total_free_pages);
1302 printf(" %5.3f", unusable_index);
1303 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1304 }
1305
1306 printf("\n");
1307 }
1308 }
1309 printf("\n");
1310}
1311
Nandana Dutt5c390032019-03-12 10:52:56 +00001312// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1313// via the consent they are shown. Ignores other errors that occur while running various
1314// commands. The consent checking is currently done around long running tasks, which happen to
1315// be distributed fairly evenly throughout the function.
1316static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001317 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001318
Nandana Dutt5c390032019-03-12 10:52:56 +00001319 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1320 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1321 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001322 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001323 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001324 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001325 DumpFile("MEMORY INFO", "/proc/meminfo");
1326 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001327 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001328
1329 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1330
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001331 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1332 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1333 DumpFile("SLAB INFO", "/proc/slabinfo");
1334 DumpFile("ZONEINFO", "/proc/zoneinfo");
1335 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1336 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001337 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001338
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001339 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1340 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001341
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001342 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001343 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001344
1345 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1346 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001347
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001348 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001349
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001350 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001351 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001352 struct stat s;
1353 if (stat("/proc/modules", &s) != 0) {
1354 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1355 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001356 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001357 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001358
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001359 if (__android_logger_property_get_bool(
1360 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1361 DoKernelLogcat();
1362 } else {
1363 do_dmesg();
1364 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001365
Felipe Lemef0292972016-11-22 13:57:05 -08001366 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001367
1368 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1369
Jeff Brown1dc94e32014-09-11 14:15:27 -07001370 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001371 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001372
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001373 /* Dump Bluetooth HCI logs */
1374 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001375
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001376 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001377 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001378 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001379 }
1380
Felipe Lemee184f662016-10-27 10:04:47 -07001381 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001382
Narayan Kamath8f788292017-05-25 13:20:39 +01001383 // NOTE: tombstones are always added as separate entries in the zip archive
1384 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001385 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001386 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001387 if (!tombstones_dumped) {
1388 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001389 }
1390
Jayachandran Ca94c7172017-06-10 15:08:12 -07001391 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001392
Chenbo Feng276a3b62018-08-07 11:44:49 -07001393 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1394
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001395 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001396
Jayachandran Ca94c7172017-06-10 15:08:12 -07001397 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001398
1399 dump_route_tables();
1400
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001401 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1402 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1403 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001404
Nandana Dutt5c390032019-03-12 10:52:56 +00001405 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001406
Elliott Hughes23ccc622017-02-28 10:14:22 -08001407 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001408
Jin Qianf334d662017-10-10 14:41:37 -07001409 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001410
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001411 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001412
Colin Crossf45fa6b2012-03-26 12:38:26 -07001413 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001414 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1415 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1416 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1417 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1418 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001419
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001420 /* Add window and surface trace files. */
1421 if (!PropertiesHelper::IsUserBuild()) {
1422 ds.AddDir(WMTRACE_DATA_DIR, false);
1423 }
1424
Nandana Dutt5c390032019-03-12 10:52:56 +00001425 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001426
Steven Moreland7440ddb2016-12-15 16:13:39 -08001427 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001428 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1429 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001430 // su does not exist on user builds, so try running without it.
1431 // This way any implementations of vril-dump that do not require
1432 // root can run on user builds.
1433 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001434 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001435 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001436 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001437 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001438 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001439 }
1440
Felipe Lemed8b94e52016-12-08 10:21:44 -08001441 printf("========================================================\n");
1442 printf("== Android Framework Services\n");
1443 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001444
Nandana Dutt5c390032019-03-12 10:52:56 +00001445 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001446
Felipe Lemed8b94e52016-12-08 10:21:44 -08001447 printf("========================================================\n");
1448 printf("== Checkins\n");
1449 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001450
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001451 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001452
1453 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1454
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001455 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1456 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1457 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1458 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001459
Felipe Lemed8b94e52016-12-08 10:21:44 -08001460 printf("========================================================\n");
1461 printf("== Running Application Activities\n");
1462 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001463
Makoto Onuki60780982018-04-16 15:34:00 -07001464 // The following dumpsys internally collects output from running apps, so it can take a long
1465 // time. So let's extend the timeout.
1466
1467 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1468
1469 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001470
Felipe Lemed8b94e52016-12-08 10:21:44 -08001471 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001472 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001473 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001474
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001475 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001476 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001477
Felipe Lemed8b94e52016-12-08 10:21:44 -08001478 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001479 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001480 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001481
Makoto Onuki60780982018-04-16 15:34:00 -07001482 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1483 DUMPSYS_COMPONENTS_OPTIONS);
1484
1485 printf("========================================================\n");
1486 printf("== Running Application Providers (platform)\n");
1487 printf("========================================================\n");
1488
1489 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1490 DUMPSYS_COMPONENTS_OPTIONS);
1491
1492 printf("========================================================\n");
1493 printf("== Running Application Providers (non-platform)\n");
1494 printf("========================================================\n");
1495
1496 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1497 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001498
Adrian Roos8b397ab2017-04-04 16:35:44 -07001499 printf("========================================================\n");
1500 printf("== Dropbox crashes\n");
1501 printf("========================================================\n");
1502
1503 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1504 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1505
Felipe Lemed8b94e52016-12-08 10:21:44 -08001506 printf("========================================================\n");
1507 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1508 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1509 printf("========================================================\n");
1510 printf("== dumpstate: done (id %d)\n", ds.id_);
1511 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001512
1513 printf("========================================================\n");
1514 printf("== Obtaining statsd metadata\n");
1515 printf("========================================================\n");
1516 // This differs from the usual dumpsys stats, which is the stats report data.
1517 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001518
1519 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1520
Nandana Dutt5c390032019-03-12 10:52:56 +00001521 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001522}
1523
Nandana Dutt5c390032019-03-12 10:52:56 +00001524/*
1525 * Dumps state for the default case; drops root after it's no longer necessary.
1526 *
1527 * Returns RunStatus::OK if everything went fine.
1528 * Returns RunStatus::ERROR if there was an error.
1529 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1530 * with the caller.
1531 */
1532static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001533 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001534 // keep the system stats as close to its initial state as possible.
Nandana Dutt5c390032019-03-12 10:52:56 +00001535 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001536
Nandana Duttdb379fa2019-10-09 16:54:41 +01001537 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1538 // buffer.
1539 DoLogcat();
1540 // Capture timestamp after first logcat to use in next logcat
1541 time_t logcat_ts = time(nullptr);
1542
Nandana Dutt4be45d12018-09-26 15:04:23 +01001543 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001544 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001545
1546 /* Run some operations that require root. */
1547 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1548 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1549
1550 ds.AddDir(RECOVERY_DIR, true);
1551 ds.AddDir(RECOVERY_DATA_DIR, true);
1552 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1553 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1554 if (!PropertiesHelper::IsUserBuild()) {
1555 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1556 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1557 }
1558 add_mountinfo();
1559 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001560 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001561 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001562
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001563 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001564 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1565
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001566 // Dump IPsec stats. No keys are exposed here.
1567 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1568
Nandana Dutt4be45d12018-09-26 15:04:23 +01001569 // Run ss as root so we can see socket marks.
1570 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1571
1572 // Run iotop as root to show top 100 IO threads
1573 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1574
Erick Reyese68df822019-02-11 14:46:36 -08001575 // Gather shared memory buffer info if the product implements it
1576 struct stat st;
1577 if (!stat("/product/bin/dmabuf_dump", &st)) {
1578 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1579 }
1580
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001581 DumpFile("PSI cpu", "/proc/pressure/cpu");
1582 DumpFile("PSI memory", "/proc/pressure/memory");
1583 DumpFile("PSI io", "/proc/pressure/io");
1584
Nandana Dutt4be45d12018-09-26 15:04:23 +01001585 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001586 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001587 }
1588
Nandana Dutt5c390032019-03-12 10:52:56 +00001589 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001590 Dumpstate::RunStatus status = dumpstate();
1591 // Capture logcat since the last time we did it.
1592 DoSystemLogcat(logcat_ts);
1593 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001594}
1595
mukesh agrawal253dad42018-01-23 21:59:59 -08001596// This method collects common dumpsys for telephony and wifi
1597static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001598 DumpIpTablesAsRoot();
1599
Jayachandran C69968272019-07-08 09:46:05 -07001600 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1601
Jayachandran Ca94c7172017-06-10 15:08:12 -07001602 if (!DropRootUser()) {
1603 return;
1604 }
1605
1606 do_dmesg();
1607 DoLogcat();
1608 DumpPacketStats();
1609 DoKmsg();
1610 DumpIpAddrAndRules();
1611 dump_route_tables();
Jayachandran C69968272019-07-08 09:46:05 -07001612 DumpHals();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001613
1614 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1615 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001616}
1617
1618// This method collects dumpsys for telephony debugging only
1619static void DumpstateTelephonyOnly() {
1620 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001621 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001622
1623 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001624
1625 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1626
1627 printf("========================================================\n");
1628 printf("== Android Framework Services\n");
1629 printf("========================================================\n");
1630
Vishnu Nair652cc802017-11-30 15:18:30 -08001631 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1632 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001633 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1634 SEC_TO_MSEC(10));
1635 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001636 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1637 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001638 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1639 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001640 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1641 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001642
1643 printf("========================================================\n");
1644 printf("== Running Application Services\n");
1645 printf("========================================================\n");
1646
1647 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1648
1649 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001650 printf("== Running Application Services (non-platform)\n");
1651 printf("========================================================\n");
1652
1653 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1654 DUMPSYS_COMPONENTS_OPTIONS);
1655
1656 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001657 printf("== Checkins\n");
1658 printf("========================================================\n");
1659
1660 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1661
1662 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001663 printf("== dumpstate: done (id %d)\n", ds.id_);
1664 printf("========================================================\n");
1665}
1666
mukesh agrawal253dad42018-01-23 21:59:59 -08001667// This method collects dumpsys for wifi debugging only
1668static void DumpstateWifiOnly() {
1669 DurationReporter duration_reporter("DUMPSTATE");
1670
1671 DumpstateRadioCommon();
1672
1673 printf("========================================================\n");
1674 printf("== Android Framework Services\n");
1675 printf("========================================================\n");
1676
1677 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1678 SEC_TO_MSEC(10));
1679 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1680 SEC_TO_MSEC(10));
1681
1682 printf("========================================================\n");
1683 printf("== dumpstate: done (id %d)\n", ds.id_);
1684 printf("========================================================\n");
1685}
1686
Nandana Duttcf419a72019-03-14 10:40:17 +00001687Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001688 DurationReporter duration_reporter("DUMP TRACES");
1689
1690 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1691 const size_t buf_size = temp_file_pattern.length() + 1;
1692 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1693 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1694
1695 // Create a new, empty file to receive all trace dumps.
1696 //
1697 // TODO: This can be simplified once we remove support for the old style
1698 // dumps. We can have a file descriptor passed in to dump_traces instead
1699 // of creating a file, closing it and then reopening it again.
1700 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1701 if (fd < 0) {
1702 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001703 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001704 }
1705
1706 // Nobody should have access to this temporary file except dumpstate, but we
1707 // temporarily grant 'read' to 'others' here because this file is created
1708 // when tombstoned is still running as root, but dumped after dropping. This
1709 // can go away once support for old style dumping has.
1710 const int chmod_ret = fchmod(fd, 0666);
1711 if (chmod_ret < 0) {
1712 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001713 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001714 }
1715
1716 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1717 if (proc.get() == nullptr) {
1718 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001719 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001720 }
1721
1722 // Number of times process dumping has timed out. If we encounter too many
1723 // failures, we'll give up.
1724 int timeout_failures = 0;
1725 bool dalvik_found = false;
1726
1727 const std::set<int> hal_pids = get_interesting_hal_pids();
1728
1729 struct dirent* d;
1730 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001731 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001732 int pid = atoi(d->d_name);
1733 if (pid <= 0) {
1734 continue;
1735 }
1736
1737 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1738 std::string exe;
1739 if (!android::base::Readlink(link_name, &exe)) {
1740 continue;
1741 }
1742
1743 bool is_java_process;
1744 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1745 // Don't bother dumping backtraces for the zygote.
1746 if (IsZygote(pid)) {
1747 continue;
1748 }
1749
1750 dalvik_found = true;
1751 is_java_process = true;
1752 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1753 is_java_process = false;
1754 } else {
1755 // Probably a native process we don't care about, continue.
1756 continue;
1757 }
1758
1759 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1760 if (timeout_failures == 3) {
1761 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1762 break;
1763 }
1764
1765 const uint64_t start = Nanotime();
1766 const int ret = dump_backtrace_to_file_timeout(
1767 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1768 is_java_process ? 5 : 20, fd);
1769
1770 if (ret == -1) {
1771 // For consistency, the header and footer to this message match those
1772 // dumped by debuggerd in the success case.
1773 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1774 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1775 dprintf(fd, "---- end %d ----", pid);
1776 timeout_failures++;
1777 continue;
1778 }
1779
1780 // We've successfully dumped stack traces, reset the failure count
1781 // and write a summary of the elapsed time to the file and continue with the
1782 // next process.
1783 timeout_failures = 0;
1784
1785 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1786 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1787 }
1788
1789 if (!dalvik_found) {
1790 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1791 }
1792
Nandana Duttcf419a72019-03-14 10:40:17 +00001793 *path = file_name_buf.release();
1794 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001795}
1796
Felipe Leme6f674ae2016-11-18 17:10:33 -08001797void Dumpstate::DumpstateBoard() {
1798 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001799 printf("========================================================\n");
1800 printf("== Board\n");
1801 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001802
Felipe Leme6f674ae2016-11-18 17:10:33 -08001803 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001804 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001805 return;
1806 }
1807
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001808 std::vector<std::string> paths;
1809 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001810 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001811 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1812 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001813 remover.emplace_back(android::base::make_scope_guard(
1814 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001815 }
Jie Song9fbfad02017-06-20 16:29:42 -07001816
Wei Wang587eac92018-04-05 12:17:20 -07001817 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1818 if (dumpstate_device == nullptr) {
1819 MYLOGE("No IDumpstateDevice implementation\n");
1820 return;
1821 }
1822
1823 using ScopedNativeHandle =
1824 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1825 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1826 [](native_handle_t* handle) {
1827 native_handle_close(handle);
1828 native_handle_delete(handle);
1829 });
1830 if (handle == nullptr) {
1831 MYLOGE("Could not create native_handle\n");
1832 return;
1833 }
1834
Nandana Dutt5c390032019-03-12 10:52:56 +00001835 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001836 for (size_t i = 0; i < paths.size(); i++) {
1837 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1838
1839 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1840 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1841 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1842 if (fd < 0) {
1843 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1844 return;
1845 }
1846 handle.get()->data[i] = fd.release();
1847 }
1848
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001849 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001850 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1851 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1852 // and grab whatever dumped
1853 std::packaged_task<bool()>
1854 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001855 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1856 if (!status.isOk()) {
1857 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001858 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001859 }
Wei Wang587eac92018-04-05 12:17:20 -07001860 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001861 });
Wei Wang587eac92018-04-05 12:17:20 -07001862
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001863 auto result = dumpstate_task.get_future();
1864 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001865
1866 constexpr size_t timeout_sec = 30;
1867 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1868 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1869 if (!android::base::SetProperty("ctl.interface_restart",
1870 android::base::StringPrintf("%s/default",
1871 IDumpstateDevice::descriptor))) {
1872 MYLOGE("Couldn't restart dumpstate HAL\n");
1873 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001874 }
Wei Wang587eac92018-04-05 12:17:20 -07001875 // Wait some time for init to kill dumpstate vendor HAL
1876 constexpr size_t killing_timeout_sec = 10;
1877 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1878 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1879 "there might be racing in content\n", killing_timeout_sec);
1880 }
1881
1882 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1883 for (size_t i = 0; i < paths.size(); i++) {
1884 struct stat s;
1885 if (fstat(handle.get()->data[i], &s) == -1) {
1886 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1887 strerror(errno));
1888 file_sizes[i] = -1;
1889 continue;
1890 }
1891 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001892 }
1893
1894 for (size_t i = 0; i < paths.size(); i++) {
1895 if (file_sizes[i] == -1) {
1896 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001897 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001898 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001899 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001900 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001901 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001902 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001903 }
1904
Felipe Lemed8b94e52016-12-08 10:21:44 -08001905 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001906}
1907
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001908static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001909 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001910 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001911 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1912 " -h: display this help message\n"
1913 " -b: play sound file instead of vibrate, at beginning of job\n"
1914 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001915 " -d: append date to filename\n"
1916 " -p: capture screenshot to filename.png\n"
1917 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001918 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001919 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001920 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001921 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001922 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001923 "progress (requires -B)\n"
1924 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001925 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001926 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001927 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001928}
1929
Wei Liuf87959e2016-08-26 14:51:42 -07001930static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001931 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001932}
1933
Felipe Leme1d486fe2016-10-14 18:06:47 -07001934bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001935 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001936 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001937 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001938 // Final timestamp
1939 char date[80];
1940 time_t the_real_now_please_stand_up = time(nullptr);
1941 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001942 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001943 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001944
Felipe Leme9a523ae2016-10-20 15:10:33 -07001945 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001946 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001947 return false;
1948 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001949 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001950 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001951 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001952 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001953
Felipe Leme0f3fb202016-06-10 17:10:53 -07001954 // Add log file (which contains stderr output) to zip...
1955 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001956 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001957 MYLOGE("Failed to add dumpstate log to .zip file\n");
1958 return false;
1959 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001960 // TODO: Should truncate the existing file.
1961 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001962 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1963 return false;
1964 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001965 fprintf(stderr, "\n");
1966
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001967 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001968 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001969 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001970 return false;
1971 }
1972
Felipe Leme1d486fe2016-10-14 18:06:47 -07001973 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1974 ds.zip_file.reset(nullptr);
1975
Felipe Lemee9d2c542016-11-15 11:48:26 -08001976 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001977 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001978
Felipe Leme1e9edc62015-12-21 16:02:13 -08001979 return true;
1980}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001981
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07001982static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07001983 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
1984 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07001985 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001986 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001987 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001988 }
1989
1990 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001991 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001992
1993 std::vector<uint8_t> buffer(65536);
1994 while (1) {
1995 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
1996 if (bytes_read == 0) {
1997 break;
1998 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001999 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002000 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002001 }
2002
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002003 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002004 }
2005
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002006 uint8_t hash[SHA256_DIGEST_LENGTH];
2007 SHA256_Final(hash, &ctx);
2008
2009 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
2010 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00002011 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002012 }
2013 hash_buffer[sizeof(hash_buffer) - 1] = 0;
2014 return std::string(hash_buffer);
2015}
2016
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002017static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2018 // clang-format off
2019 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2020 "--receiver-foreground", "--receiver-include-background", "-a", action};
2021 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002022
2023 am.insert(am.end(), args.begin(), args.end());
2024
Felipe Leme8d2410e2017-02-08 09:46:08 -08002025 RunCommand("", am,
2026 CommandOptions::WithTimeout(20)
2027 .Log("Sending broadcast: '%s'\n")
2028 .Always()
2029 .DropRoot()
2030 .RedirectStderr()
2031 .Build());
2032}
2033
Felipe Leme35b8cf12017-02-10 15:47:29 -08002034static void Vibrate(int duration_ms) {
2035 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002036 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002037 CommandOptions::WithTimeout(10)
2038 .Log("Vibrate: '%s'\n")
2039 .Always()
2040 .Build());
2041 // clang-format on
2042}
2043
Nandana Dutt979388e2018-11-30 16:48:55 +00002044static void MaybeResolveSymlink(std::string* path) {
2045 std::string resolved_path;
2046 if (android::base::Readlink(*path, &resolved_path)) {
2047 *path = resolved_path;
2048 }
2049}
2050
Nandana Dutt4be45d12018-09-26 15:04:23 +01002051/*
2052 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2053 * if we are writing zip files and adds the version file.
2054 */
2055static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002056 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2057
Nandana Dutt4be45d12018-09-26 15:04:23 +01002058 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2059 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002060 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002061 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002062 char date[80];
2063 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2064 ds.name_ = date;
2065 } else {
2066 ds.name_ = "undated";
2067 }
2068
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002069 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002070 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002071 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002072 ds.base_name_ += "-wifi";
2073 }
2074
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002075 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002076 ds.screenshot_path_ = ds.GetPath(".png");
2077 }
2078 ds.tmp_path_ = ds.GetPath(".tmp");
2079 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2080
Nandana Dutt54dbd672019-01-11 12:58:05 +00002081 std::string destination = ds.options_->bugreport_fd.get() != -1
2082 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002083 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002084 MYLOGD(
2085 "Bugreport dir: %s\n"
2086 "Base name: %s\n"
2087 "Suffix: %s\n"
2088 "Log path: %s\n"
2089 "Temporary path: %s\n"
2090 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002091 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2092 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002093
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002094 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002095 ds.path_ = ds.GetPath(".zip");
2096 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2097 create_parent_dirs(ds.path_.c_str());
2098 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2099 if (ds.zip_file == nullptr) {
2100 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2101 } else {
2102 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2103 }
2104 ds.AddTextZipEntry("version.txt", ds.version_);
2105 }
2106}
2107
2108/*
2109 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
2110 * printing zipped file status, etc.
2111 */
2112static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002113 /* check if user changed the suffix using system properties */
2114 std::string name =
2115 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
2116 bool change_suffix = false;
2117 if (!name.empty()) {
2118 /* must whitelist which characters are allowed, otherwise it could cross directories */
2119 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
2120 if (std::regex_match(name.c_str(), valid_regex)) {
2121 change_suffix = true;
2122 } else {
2123 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
2124 }
2125 }
2126 if (change_suffix) {
2127 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
2128 ds.name_ = name;
2129 if (!ds.screenshot_path_.empty()) {
2130 std::string new_screenshot_path = ds.GetPath(".png");
2131 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
2132 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
2133 new_screenshot_path.c_str(), strerror(errno));
2134 } else {
2135 ds.screenshot_path_ = new_screenshot_path;
2136 }
2137 }
2138 }
2139
2140 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002141 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002142 if (!ds.FinishZipFile()) {
2143 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2144 do_text_file = true;
2145 } else {
2146 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002147 // If the user has changed the suffix, we need to change the zip file name.
2148 std::string new_path = ds.GetPath(".zip");
2149 if (ds.path_ != new_path) {
2150 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2151 if (rename(ds.path_.c_str(), new_path.c_str())) {
2152 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2153 strerror(errno));
2154 } else {
2155 ds.path_ = new_path;
2156 }
2157 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002158 }
2159 }
2160 if (do_text_file) {
2161 ds.path_ = ds.GetPath(".txt");
2162 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2163 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2164 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2165 ds.path_.clear();
2166 }
2167 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002168 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002169 if (do_text_file) {
2170 dprintf(ds.control_socket_fd_,
2171 "FAIL:could not create zip file, check %s "
2172 "for more details\n",
2173 ds.log_path_.c_str());
2174 } else {
2175 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2176 }
2177 }
2178}
2179
2180/* Broadcasts that we are done with the bugreport */
2181static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002182 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002183 if (!ds.path_.empty()) {
2184 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002185 // clang-format off
2186
2187 std::vector<std::string> am_args = {
2188 "--receiver-permission", "android.permission.DUMP",
2189 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2190 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2191 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002192 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002193 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2194 };
2195 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002196 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002197 am_args.push_back("--es");
2198 am_args.push_back("android.intent.extra.SCREENSHOT");
2199 am_args.push_back(ds.screenshot_path_);
2200 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002201 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002202 am_args.push_back("--es");
2203 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002204 am_args.push_back(ds.options_->notification_title);
2205 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002206 am_args.push_back("--es");
2207 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002208 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002209 }
2210 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002211 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002212 am_args.push_back("--es");
2213 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002214 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002215 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2216 } else {
2217 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2218 }
2219 } else {
2220 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2221 }
2222}
2223
Nandana Dutt58d72e22018-11-16 10:30:48 +00002224static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2225 switch (mode) {
2226 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2227 return "BUGREPORT_FULL";
2228 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2229 return "BUGREPORT_INTERACTIVE";
2230 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2231 return "BUGREPORT_REMOTE";
2232 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2233 return "BUGREPORT_WEAR";
2234 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2235 return "BUGREPORT_TELEPHONY";
2236 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2237 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002238 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2239 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002240 }
2241}
2242
2243static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002244 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002245 switch (mode) {
2246 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2247 options->do_broadcast = true;
2248 options->do_fb = true;
2249 break;
2250 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002251 // Currently, the dumpstate binder is only used by Shell to update progress.
2252 options->do_start_service = true;
2253 options->do_progress_updates = true;
2254 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002255 options->do_broadcast = true;
2256 break;
2257 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002258 options->do_vibrate = false;
2259 options->is_remote_mode = true;
2260 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002261 options->do_broadcast = true;
2262 break;
2263 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002264 options->do_start_service = true;
2265 options->do_progress_updates = true;
2266 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002267 options->do_fb = true;
2268 options->do_broadcast = true;
2269 break;
2270 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002271 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002272 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002273 options->do_broadcast = true;
2274 break;
2275 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002276 options->wifi_only = true;
2277 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002278 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002279 options->do_broadcast = true;
2280 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002281 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2282 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002283 }
2284}
2285
2286static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002287 // If the system property is not set, it's assumed to be a default bugreport.
2288 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002289
2290 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2291 if (!extra_options.empty()) {
2292 // Framework uses a system property to override some command-line args.
2293 // Currently, it contains the type of the requested bugreport.
2294 if (extra_options == "bugreportplus") {
2295 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002296 } else if (extra_options == "bugreportfull") {
2297 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002298 } else if (extra_options == "bugreportremote") {
2299 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2300 } else if (extra_options == "bugreportwear") {
2301 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2302 } else if (extra_options == "bugreporttelephony") {
2303 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2304 } else if (extra_options == "bugreportwifi") {
2305 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002306 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002307 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002308 }
2309 // Reset the property
2310 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2311 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002312 return mode;
2313}
2314
2315// TODO: Move away from system properties when we have options passed via binder calls.
2316/* Sets runtime options from the system properties and then clears those properties. */
2317static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2318 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2319 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002320
2321 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2322 if (!options->notification_title.empty()) {
2323 // Reset the property
2324 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2325
Nandana Duttdd8cca32018-11-14 10:10:29 +00002326 options->notification_description =
2327 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002328 if (!options->notification_description.empty()) {
2329 // Reset the property
2330 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2331 }
2332 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2333 options->notification_description.c_str());
2334 }
2335}
2336
Nandana Dutt58d72e22018-11-16 10:30:48 +00002337static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2338 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2339 MYLOGI("do_add_date: %d\n", options.do_add_date);
2340 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2341 MYLOGI("use_socket: %d\n", options.use_socket);
2342 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2343 MYLOGI("do_fb: %d\n", options.do_fb);
2344 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2345 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2346 MYLOGI("show_header_only: %d\n", options.show_header_only);
2347 MYLOGI("do_start_service: %d\n", options.do_start_service);
2348 MYLOGI("telephony_only: %d\n", options.telephony_only);
2349 MYLOGI("wifi_only: %d\n", options.wifi_only);
2350 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002351 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002352 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2353 MYLOGI("args: %s\n", options.args.c_str());
2354 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2355 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2356}
2357
Nandana Dutt54dbd672019-01-11 12:58:05 +00002358void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2359 const android::base::unique_fd& bugreport_fd_in,
2360 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002361 // In the new API world, date is always added; output is always a zip file.
2362 // TODO(111441001): remove these options once they are obsolete.
2363 do_add_date = true;
2364 do_zip_file = true;
2365
Nandana Dutt54dbd672019-01-11 12:58:05 +00002366 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2367 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2368 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002369
2370 extra_options = ModeToString(bugreport_mode);
2371 SetOptionsFromMode(bugreport_mode, this);
2372}
2373
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002374Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2375 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002376 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002377 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002378 switch (c) {
2379 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002380 case 'd': do_add_date = true; break;
2381 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002382 // o=use_outfile not supported anymore.
2383 // TODO(b/111441001): Remove when all callers have migrated.
2384 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002385 case 's': use_socket = true; break;
2386 case 'S': use_control_socket = true; break;
2387 case 'v': show_header_only = true; break;
2388 case 'q': do_vibrate = false; break;
2389 case 'p': do_fb = true; break;
2390 case 'P': do_progress_updates = true; break;
2391 case 'R': is_remote_mode = true; break;
2392 case 'B': do_broadcast = true; break;
2393 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002394 case 'w':
2395 // This was already processed
2396 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002397 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002398 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002399 break;
2400 default:
2401 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002402 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002403 break;
2404 // clang-format on
2405 }
2406 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002407
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002408 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002409 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002410 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002411 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002412 }
2413 }
2414
2415 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2416 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002417
2418 SetOptionsFromProperties(this);
2419 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002420}
2421
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002422bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002423 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002424 return false;
2425 }
2426
Nandana Dutt9a76d202019-01-21 15:56:48 +00002427 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002428 return false;
2429 }
2430
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002431 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002432 return false;
2433 }
2434
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002435 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002436 return false;
2437 }
2438
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002439 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002440 return false;
2441 }
2442 return true;
2443}
2444
Nandana Dutt197661d2018-11-16 16:40:21 +00002445void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2446 options_ = std::move(options);
2447}
2448
Nandana Duttd2f5f082019-01-18 17:13:52 +00002449Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2450 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002451 if (listener_ != nullptr) {
2452 switch (status) {
2453 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002454 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002455 break;
2456 case Dumpstate::RunStatus::HELP:
2457 break;
2458 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002459 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002460 break;
2461 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002462 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2463 break;
2464 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2465 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2466 break;
2467 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2468 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002469 break;
2470 }
2471 }
2472 return status;
2473}
2474
Nandana Dutt979388e2018-11-30 16:48:55 +00002475/*
2476 * Dumps relevant information to a bugreport based on the given options.
2477 *
2478 * The bugreport can be dumped to a file or streamed to a socket.
2479 *
2480 * How dumping to file works:
2481 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2482 * stderr is redirected a log file.
2483 *
2484 * The temporary bugreport is then populated via printfs, dumping contents of files and
2485 * output of commands to stdout.
2486 *
2487 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2488 * text file.
2489 *
2490 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2491 * gets added to the archive.
2492 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002493 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2494 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002495 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002496Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2497 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002498 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002499 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002500 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002501 return RunStatus::INVALID_INPUT;
2502 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002503 /* set as high priority, and protect from OOM killer */
2504 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002505
Felipe Lemed071c682016-10-20 16:48:00 -07002506 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002507 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002508 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002509 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002510 } else {
2511 /* fallback to kernels <= 2.6.35 */
2512 oom_adj = fopen("/proc/self/oom_adj", "we");
2513 if (oom_adj) {
2514 fputs("-17", oom_adj);
2515 fclose(oom_adj);
2516 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002517 }
2518
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002519 if (version_ == VERSION_DEFAULT) {
2520 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002521 }
2522
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002523 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002524 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002525 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002526 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002527 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002528 }
2529
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002530 if (options_->show_header_only) {
2531 PrintHeader();
2532 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002533 }
2534
Nandana Duttd2f5f082019-01-18 17:13:52 +00002535 if (options_->bugreport_fd.get() != -1) {
2536 // If the output needs to be copied over to the caller's fd, get user consent.
2537 android::String16 package(calling_package.c_str());
2538 CheckUserConsent(calling_uid, package);
2539 }
2540
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002541 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002542 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002543
2544 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002545 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002546 is_redirecting
2547 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2548 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002549 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002550
Felipe Lemed071c682016-10-20 16:48:00 -07002551 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002552 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002553 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002554 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2555
2556 MYLOGI("begin\n");
2557
Sahana Raof35ed432019-07-12 10:47:52 +01002558 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2559 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2560 } else {
2561 // Wake lock will be released automatically on process death
2562 MYLOGD("Wake lock acquired.\n");
2563 }
2564
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002565 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002566
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002567 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002568 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002569 MYLOGI("Starting 'dumpstate' service\n");
2570 android::status_t ret;
2571 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2572 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2573 }
2574 }
2575
Felipe Lemef0292972016-11-22 13:57:05 -08002576 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002577 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2578 }
2579
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002580 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2581 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002582
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002583 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002584
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002585 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002586
Christopher Ferrised9354f2014-10-01 17:35:01 -07002587 // If we are going to use a socket, do it as early as possible
2588 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002589 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002590 if (!redirect_to_socket(stdout, "dumpstate")) {
2591 return ERROR;
2592 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002593 }
2594
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002595 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002596 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002597 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002598 if (control_socket_fd_ == -1) {
2599 return ERROR;
2600 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002601 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002602 }
2603
Felipe Leme71bbfc52015-11-23 14:14:51 -08002604 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002605 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002606
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002607 if (options_->do_progress_updates) {
2608 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002609 // clang-format off
2610 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002611 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002612 "--es", "android.intent.extra.NAME", name_,
2613 "--ei", "android.intent.extra.ID", std::to_string(id_),
2614 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2615 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002616 };
2617 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002618 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002619 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002620 if (options_->use_control_socket) {
2621 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002622 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002623 }
2624 }
2625
Nick Kralevichf3599b32016-01-25 15:05:16 -08002626 /* read /proc/cmdline before dropping root */
2627 FILE *cmdline = fopen("/proc/cmdline", "re");
2628 if (cmdline) {
2629 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2630 fclose(cmdline);
2631 }
2632
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002633 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002634 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002635 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002636
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002637 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002638 MYLOGI("taking early screenshot\n");
2639 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002640 }
2641
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002642 if (options_->do_zip_file && zip_file != nullptr) {
2643 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2644 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002645 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002646 }
2647 }
2648
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002649 int dup_stdout_fd;
2650 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002651 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002652 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002653 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002654 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2655 return ERROR;
2656 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002657 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2658 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2659 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002660 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002661
2662 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2663 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002664 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002665 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002666 /* TODO: rather than generating a text file now and zipping it later,
2667 it would be more efficient to redirect stdout to the zip entry
2668 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002669 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2670 return ERROR;
2671 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002672 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002673 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002674 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002675 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002676 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002677
2678 // Don't buffer stdout
2679 setvbuf(stdout, nullptr, _IONBF, 0);
2680
Felipe Leme608385d2016-02-01 10:35:38 -08002681 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2682 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002683 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002684 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002685
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002686 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002687 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002688 DumpstateBoard();
2689 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002690 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002691 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002692 // Dump state for the default case. This also drops root.
Nandana Dutt5c390032019-03-12 10:52:56 +00002693 RunStatus s = DumpstateDefault();
2694 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002695 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002696 HandleUserConsentDenied();
2697 }
2698 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002699 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002700 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002701
Felipe Leme55b42a62015-11-10 17:39:08 -08002702 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002703 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002704 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002705 }
2706
Nandana Duttd2f5f082019-01-18 17:13:52 +00002707 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002708 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002709 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002710 }
2711
Nandana Duttd2f5f082019-01-18 17:13:52 +00002712 // Share the final file with the caller if the user has consented.
2713 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2714 if (options_->bugreport_fd.get() != -1) {
2715 status = CopyBugreportIfUserConsented();
2716 if (status != Dumpstate::RunStatus::OK &&
2717 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2718 // Do an early return if there were errors. We make an exception for consent
2719 // timing out because it's possible the user got distracted. In this case the
2720 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002721 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002722 return status;
2723 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002724 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002725 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2726 options_->screenshot_fd.get());
2727 if (copy_succeeded) {
2728 android::os::UnlinkAndLogOnError(screenshot_path_);
2729 }
2730 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002731 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2732 MYLOGI(
2733 "Did not receive user consent yet."
2734 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002735 const String16 incidentcompanion("incidentcompanion");
2736 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2737 if (ics != nullptr) {
2738 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2739 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2740 consent_callback_.get());
2741 } else {
2742 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2743 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002744 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002745 }
2746
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002747 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002748 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002749 for (int i = 0; i < 3; i++) {
2750 Vibrate(75);
2751 usleep((75 + 50) * 1000);
2752 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002753 }
2754
Jeff Brown1dc94e32014-09-11 14:15:27 -07002755 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002756 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002757 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002758 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002759 }
2760
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002761 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2762 progress_->GetInitialMax());
2763 progress_->Save();
2764 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002765
Felipe Leme107a05f2016-03-08 15:11:15 -08002766 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002767 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002768 }
2769
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002770 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002771 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002772 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002773 }
2774
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002775 tombstone_data_.clear();
2776 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002777
Nandana Duttd2f5f082019-01-18 17:13:52 +00002778 return (consent_callback_ != nullptr &&
2779 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2780 ? USER_CONSENT_TIMED_OUT
2781 : RunStatus::OK;
2782}
2783
2784void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2785 consent_callback_ = new ConsentCallback();
2786 const String16 incidentcompanion("incidentcompanion");
2787 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2788 if (ics != nullptr) {
2789 MYLOGD("Checking user consent via incidentcompanion service\n");
2790 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Joe Onorato1c36d752019-03-17 18:26:43 -07002791 calling_uid, calling_package, String16(), String16(),
2792 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002793 } else {
2794 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2795 }
2796}
2797
Nandana Dutt5c390032019-03-12 10:52:56 +00002798bool Dumpstate::IsUserConsentDenied() const {
2799 return ds.consent_callback_ != nullptr &&
2800 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2801}
2802
Nandana Duttd2f5f082019-01-18 17:13:52 +00002803void Dumpstate::CleanupFiles() {
2804 android::os::UnlinkAndLogOnError(tmp_path_);
2805 android::os::UnlinkAndLogOnError(screenshot_path_);
2806 android::os::UnlinkAndLogOnError(path_);
2807}
2808
2809Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2810 MYLOGD("User denied consent; deleting files and returning\n");
2811 CleanupFiles();
2812 return USER_CONSENT_DENIED;
2813}
2814
2815Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2816 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2817 // user consent.
2818 UserConsentResult consent_result = consent_callback_->getResult();
2819 if (consent_result == UserConsentResult::UNAVAILABLE) {
2820 // User has not responded yet.
2821 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2822 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2823 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2824 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2825 sleep(delay_seconds);
2826 }
2827 consent_result = consent_callback_->getResult();
2828 }
2829 if (consent_result == UserConsentResult::DENIED) {
2830 // User has explicitly denied sharing with the app. To be safe delete the
2831 // internal bugreport & tmp files.
2832 return HandleUserConsentDenied();
2833 }
2834 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002835 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2836 if (copy_succeeded) {
2837 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002838 }
2839 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2840 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2841 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2842 // Since we do not have user consent to share the bugreport it does not get
2843 // copied over to the calling app but remains in the internal directory from
2844 // where the user can manually pull it.
2845 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2846 }
2847 // Unknown result; must be a programming error.
2848 MYLOGE("Unknown user consent result:%d\n", consent_result);
2849 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002850}
2851
Nandana Duttf02564e2019-02-15 15:24:24 +00002852Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002853 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2854 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2855 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002856 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002857 // When directly running dumpstate binary, the output is not expected to be written
2858 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002859 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002860
2861 // calling_uid and calling_package are for user consent to share the bugreport with
2862 // an app; they are irrelvant here because bugreport is only written to a local
2863 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002864 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002865 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002866 return status;
2867}
2868
2869/* Main entry point for dumpstate binary. */
2870int run_main(int argc, char* argv[]) {
2871 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002872
2873 switch (status) {
2874 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002875 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002876 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002877 ShowUsage();
2878 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002879 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002880 fprintf(stderr, "Invalid combination of args\n");
2881 ShowUsage();
2882 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002883 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002884 FALLTHROUGH_INTENDED;
2885 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2886 FALLTHROUGH_INTENDED;
2887 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002888 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002889 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002890}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002891
2892// TODO(111441001): Default DumpOptions to sensible values.
2893Dumpstate::Dumpstate(const std::string& version)
2894 : pid_(getpid()),
2895 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01002896 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002897 version_(version),
2898 now_(time(nullptr)) {
2899}
2900
2901Dumpstate& Dumpstate::GetInstance() {
2902 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2903 return singleton_;
2904}
2905
Nandana Dutt8d945c02019-08-14 13:30:07 +01002906DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2907 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002908 if (!title_.empty()) {
2909 started_ = Nanotime();
2910 }
2911}
2912
2913DurationReporter::~DurationReporter() {
2914 if (!title_.empty()) {
2915 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002916 if (elapsed >= .5f || verbose_) {
2917 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002918 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002919 if (!logcat_only_) {
2920 // Use "Yoda grammar" to make it easier to grep|sort sections.
2921 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002922 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002923 }
2924}
2925
2926const int32_t Progress::kDefaultMax = 5000;
2927
2928Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2929}
2930
2931Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2932 : Progress(initial_max, growth_factor, "") {
2933 progress_ = progress;
2934}
2935
2936Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2937 : initial_max_(initial_max),
2938 progress_(0),
2939 max_(initial_max),
2940 growth_factor_(growth_factor),
2941 n_runs_(0),
2942 average_max_(0),
2943 path_(path) {
2944 if (!path_.empty()) {
2945 Load();
2946 }
2947}
2948
2949void Progress::Load() {
2950 MYLOGD("Loading stats from %s\n", path_.c_str());
2951 std::string content;
2952 if (!android::base::ReadFileToString(path_, &content)) {
2953 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2954 return;
2955 }
2956 if (content.empty()) {
2957 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2958 return;
2959 }
2960 std::vector<std::string> lines = android::base::Split(content, "\n");
2961
2962 if (lines.size() < 1) {
2963 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2964 (int)lines.size(), max_);
2965 return;
2966 }
2967 char* ptr;
2968 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2969 average_max_ = strtol(ptr, nullptr, 10);
2970 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2971 average_max_ > STATS_MAX_AVERAGE) {
2972 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2973 initial_max_ = Progress::kDefaultMax;
2974 } else {
2975 initial_max_ = average_max_;
2976 }
2977 max_ = initial_max_;
2978
2979 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2980}
2981
2982void Progress::Save() {
2983 int32_t total = n_runs_ * average_max_ + progress_;
2984 int32_t runs = n_runs_ + 1;
2985 int32_t average = floor(((float)total) / runs);
2986 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2987 path_.c_str());
2988 if (path_.empty()) {
2989 return;
2990 }
2991
2992 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2993 if (!android::base::WriteStringToFile(content, path_)) {
2994 MYLOGE("Could not save stats on %s\n", path_.c_str());
2995 }
2996}
2997
2998int32_t Progress::Get() const {
2999 return progress_;
3000}
3001
3002bool Progress::Inc(int32_t delta_sec) {
3003 bool changed = false;
3004 if (delta_sec >= 0) {
3005 progress_ += delta_sec;
3006 if (progress_ > max_) {
3007 int32_t old_max = max_;
3008 max_ = floor((float)progress_ * growth_factor_);
3009 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3010 changed = true;
3011 }
3012 }
3013 return changed;
3014}
3015
3016int32_t Progress::GetMax() const {
3017 return max_;
3018}
3019
3020int32_t Progress::GetInitialMax() const {
3021 return initial_max_;
3022}
3023
3024void Progress::Dump(int fd, const std::string& prefix) const {
3025 const char* pr = prefix.c_str();
3026 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3027 dprintf(fd, "%smax: %d\n", pr, max_);
3028 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3029 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3030 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3031 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3032 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3033}
3034
3035bool Dumpstate::IsZipping() const {
3036 return zip_writer_ != nullptr;
3037}
3038
3039std::string Dumpstate::GetPath(const std::string& suffix) const {
3040 return GetPath(bugreport_internal_dir_, suffix);
3041}
3042
3043std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3044 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3045 name_.c_str(), suffix.c_str());
3046}
3047
3048void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3049 progress_ = std::move(progress);
3050}
3051
3052void for_each_userid(void (*func)(int), const char *header) {
3053 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3054 "for_each_userid(%s)", header);
3055 DurationReporter duration_reporter(title);
3056 if (PropertiesHelper::IsDryRun()) return;
3057
3058 DIR *d;
3059 struct dirent *de;
3060
3061 if (header) printf("\n------ %s ------\n", header);
3062 func(0);
3063
3064 if (!(d = opendir("/data/system/users"))) {
3065 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3066 return;
3067 }
3068
3069 while ((de = readdir(d))) {
3070 int userid;
3071 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3072 continue;
3073 }
3074 func(userid);
3075 }
3076
3077 closedir(d);
3078}
3079
3080static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3081 DIR *d;
3082 struct dirent *de;
3083
3084 if (!(d = opendir("/proc"))) {
3085 printf("Failed to open /proc (%s)\n", strerror(errno));
3086 return;
3087 }
3088
3089 if (header) printf("\n------ %s ------\n", header);
3090 while ((de = readdir(d))) {
3091 if (ds.IsUserConsentDenied()) {
3092 MYLOGE(
3093 "Returning early because user denied consent to share bugreport with calling app.");
3094 closedir(d);
3095 return;
3096 }
3097 int pid;
3098 int fd;
3099 char cmdpath[255];
3100 char cmdline[255];
3101
3102 if (!(pid = atoi(de->d_name))) {
3103 continue;
3104 }
3105
3106 memset(cmdline, 0, sizeof(cmdline));
3107
3108 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3109 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3110 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3111 close(fd);
3112 if (cmdline[0]) {
3113 helper(pid, cmdline, arg);
3114 continue;
3115 }
3116 }
3117
3118 // if no cmdline, a kernel thread has comm
3119 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3120 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3121 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3122 close(fd);
3123 if (cmdline[1]) {
3124 cmdline[0] = '[';
3125 size_t len = strcspn(cmdline, "\f\b\r\n");
3126 cmdline[len] = ']';
3127 cmdline[len+1] = '\0';
3128 }
3129 }
3130 if (!cmdline[0]) {
3131 strcpy(cmdline, "N/A");
3132 }
3133 helper(pid, cmdline, arg);
3134 }
3135
3136 closedir(d);
3137}
3138
3139static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3140 for_each_pid_func *func = (for_each_pid_func*) arg;
3141 func(pid, cmdline);
3142}
3143
3144void for_each_pid(for_each_pid_func func, const char *header) {
3145 std::string title = header == nullptr ? "for_each_pid"
3146 : android::base::StringPrintf("for_each_pid(%s)", header);
3147 DurationReporter duration_reporter(title);
3148 if (PropertiesHelper::IsDryRun()) return;
3149
3150 __for_each_pid(for_each_pid_helper, header, (void *) func);
3151}
3152
3153static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3154 DIR *d;
3155 struct dirent *de;
3156 char taskpath[255];
3157 for_each_tid_func *func = (for_each_tid_func *) arg;
3158
3159 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3160
3161 if (!(d = opendir(taskpath))) {
3162 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3163 return;
3164 }
3165
3166 func(pid, pid, cmdline);
3167
3168 while ((de = readdir(d))) {
3169 if (ds.IsUserConsentDenied()) {
3170 MYLOGE(
3171 "Returning early because user denied consent to share bugreport with calling app.");
3172 closedir(d);
3173 return;
3174 }
3175 int tid;
3176 int fd;
3177 char commpath[255];
3178 char comm[255];
3179
3180 if (!(tid = atoi(de->d_name))) {
3181 continue;
3182 }
3183
3184 if (tid == pid)
3185 continue;
3186
3187 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3188 memset(comm, 0, sizeof(comm));
3189 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3190 strcpy(comm, "N/A");
3191 } else {
3192 char *c;
3193 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3194 close(fd);
3195
3196 c = strrchr(comm, '\n');
3197 if (c) {
3198 *c = '\0';
3199 }
3200 }
3201 func(pid, tid, comm);
3202 }
3203
3204 closedir(d);
3205}
3206
3207void for_each_tid(for_each_tid_func func, const char *header) {
3208 std::string title = header == nullptr ? "for_each_tid"
3209 : android::base::StringPrintf("for_each_tid(%s)", header);
3210 DurationReporter duration_reporter(title);
3211
3212 if (PropertiesHelper::IsDryRun()) return;
3213
3214 __for_each_pid(for_each_tid_helper, header, (void *) func);
3215}
3216
3217void show_wchan(int pid, int tid, const char *name) {
3218 if (PropertiesHelper::IsDryRun()) return;
3219
3220 char path[255];
3221 char buffer[255];
3222 int fd, ret, save_errno;
3223 char name_buffer[255];
3224
3225 memset(buffer, 0, sizeof(buffer));
3226
3227 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3228 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3229 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3230 return;
3231 }
3232
3233 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3234 save_errno = errno;
3235 close(fd);
3236
3237 if (ret < 0) {
3238 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3239 return;
3240 }
3241
3242 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3243 pid == tid ? 0 : 3, "", name);
3244
3245 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3246
3247 return;
3248}
3249
3250// print time in centiseconds
3251static void snprcent(char *buffer, size_t len, size_t spc,
3252 unsigned long long time) {
3253 static long hz; // cache discovered hz
3254
3255 if (hz <= 0) {
3256 hz = sysconf(_SC_CLK_TCK);
3257 if (hz <= 0) {
3258 hz = 1000;
3259 }
3260 }
3261
3262 // convert to centiseconds
3263 time = (time * 100 + (hz / 2)) / hz;
3264
3265 char str[16];
3266
3267 snprintf(str, sizeof(str), " %llu.%02u",
3268 time / 100, (unsigned)(time % 100));
3269 size_t offset = strlen(buffer);
3270 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3271 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3272}
3273
3274// print permille as a percent
3275static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3276 char str[16];
3277
3278 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3279 size_t offset = strlen(buffer);
3280 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3281 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3282}
3283
3284void show_showtime(int pid, const char *name) {
3285 if (PropertiesHelper::IsDryRun()) return;
3286
3287 char path[255];
3288 char buffer[1023];
3289 int fd, ret, save_errno;
3290
3291 memset(buffer, 0, sizeof(buffer));
3292
3293 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3294 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3295 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3296 return;
3297 }
3298
3299 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3300 save_errno = errno;
3301 close(fd);
3302
3303 if (ret < 0) {
3304 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3305 return;
3306 }
3307
3308 // field 14 is utime
3309 // field 15 is stime
3310 // field 42 is iotime
3311 unsigned long long utime = 0, stime = 0, iotime = 0;
3312 if (sscanf(buffer,
3313 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3314 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3315 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3316 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3317 &utime, &stime, &iotime) != 3) {
3318 return;
3319 }
3320
3321 unsigned long long total = utime + stime;
3322 if (!total) {
3323 return;
3324 }
3325
3326 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3327 if (permille > 1000) {
3328 permille = 1000;
3329 }
3330
3331 // try to beautify and stabilize columns at <80 characters
3332 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3333 if ((name[0] != '[') || utime) {
3334 snprcent(buffer, sizeof(buffer), 57, utime);
3335 }
3336 snprcent(buffer, sizeof(buffer), 65, stime);
3337 if ((name[0] != '[') || iotime) {
3338 snprcent(buffer, sizeof(buffer), 73, iotime);
3339 }
3340 if (iotime) {
3341 snprdec(buffer, sizeof(buffer), 79, permille);
3342 }
3343 puts(buffer); // adds a trailing newline
3344
3345 return;
3346}
3347
3348void do_dmesg() {
3349 const char *title = "KERNEL LOG (dmesg)";
3350 DurationReporter duration_reporter(title);
3351 printf("------ %s ------\n", title);
3352
3353 if (PropertiesHelper::IsDryRun()) return;
3354
3355 /* Get size of kernel buffer */
3356 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3357 if (size <= 0) {
3358 printf("Unexpected klogctl return value: %d\n\n", size);
3359 return;
3360 }
3361 char *buf = (char *) malloc(size + 1);
3362 if (buf == nullptr) {
3363 printf("memory allocation failed\n\n");
3364 return;
3365 }
3366 int retval = klogctl(KLOG_READ_ALL, buf, size);
3367 if (retval < 0) {
3368 printf("klogctl failure\n\n");
3369 free(buf);
3370 return;
3371 }
3372 buf[retval] = '\0';
3373 printf("%s\n\n", buf);
3374 free(buf);
3375 return;
3376}
3377
3378void do_showmap(int pid, const char *name) {
3379 char title[255];
3380 char arg[255];
3381
3382 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3383 snprintf(arg, sizeof(arg), "%d", pid);
3384 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3385}
3386
3387int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3388 DurationReporter duration_reporter(title);
3389
3390 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3391
3392 UpdateProgress(WEIGHT_FILE);
3393
3394 return status;
3395}
3396
3397int read_file_as_long(const char *path, long int *output) {
3398 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3399 if (fd < 0) {
3400 int err = errno;
3401 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3402 return -1;
3403 }
3404 char buffer[50];
3405 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3406 if (bytes_read == -1) {
3407 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3408 return -2;
3409 }
3410 if (bytes_read == 0) {
3411 MYLOGE("File %s is empty\n", path);
3412 return -3;
3413 }
3414 *output = atoi(buffer);
3415 return 0;
3416}
3417
3418/* calls skip to gate calling dump_from_fd recursively
3419 * in the specified directory. dump_from_fd defaults to
3420 * dump_file_from_fd above when set to NULL. skip defaults
3421 * to false when set to NULL. dump_from_fd will always be
3422 * called with title NULL.
3423 */
3424int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3425 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3426 DurationReporter duration_reporter(title);
3427 DIR *dirp;
3428 struct dirent *d;
3429 char *newpath = nullptr;
3430 const char *slash = "/";
3431 int retval = 0;
3432
3433 if (!title.empty()) {
3434 printf("------ %s (%s) ------\n", title.c_str(), dir);
3435 }
3436 if (PropertiesHelper::IsDryRun()) return 0;
3437
3438 if (dir[strlen(dir) - 1] == '/') {
3439 ++slash;
3440 }
3441 dirp = opendir(dir);
3442 if (dirp == nullptr) {
3443 retval = -errno;
3444 MYLOGE("%s: %s\n", dir, strerror(errno));
3445 return retval;
3446 }
3447
3448 if (!dump_from_fd) {
3449 dump_from_fd = dump_file_from_fd;
3450 }
3451 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3452 if ((d->d_name[0] == '.')
3453 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3454 || (d->d_name[1] == '\0'))) {
3455 continue;
3456 }
3457 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3458 (d->d_type == DT_DIR) ? "/" : "");
3459 if (!newpath) {
3460 retval = -errno;
3461 continue;
3462 }
3463 if (skip && (*skip)(newpath)) {
3464 continue;
3465 }
3466 if (d->d_type == DT_DIR) {
3467 int ret = dump_files("", newpath, skip, dump_from_fd);
3468 if (ret < 0) {
3469 retval = ret;
3470 }
3471 continue;
3472 }
3473 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3474 if (fd.get() < 0) {
3475 retval = -1;
3476 printf("*** %s: %s\n", newpath, strerror(errno));
3477 continue;
3478 }
3479 (*dump_from_fd)(nullptr, newpath, fd.get());
3480 }
3481 closedir(dirp);
3482 if (!title.empty()) {
3483 printf("\n");
3484 }
3485 return retval;
3486}
3487
3488/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3489 * it's possible to avoid issues where opening the file itself can get
3490 * stuck.
3491 */
3492int dump_file_from_fd(const char *title, const char *path, int fd) {
3493 if (PropertiesHelper::IsDryRun()) return 0;
3494
3495 int flags = fcntl(fd, F_GETFL);
3496 if (flags == -1) {
3497 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3498 return -1;
3499 } else if (!(flags & O_NONBLOCK)) {
3500 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3501 return -1;
3502 }
3503 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3504}
3505
3506int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003507 const CommandOptions& options, bool verbose_duration) {
3508 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003509
3510 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3511
3512 /* TODO: for now we're simplifying the progress calculation by using the
3513 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3514 * where its weight should be much higher proportionally to its timeout.
3515 * Ideally, it should use a options.EstimatedDuration() instead...*/
3516 UpdateProgress(options.Timeout());
3517
3518 return status;
3519}
3520
3521void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3522 const CommandOptions& options, long dumpsysTimeoutMs) {
3523 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3524 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3525 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3526 RunCommand(title, dumpsys, options);
3527}
3528
3529int open_socket(const char *service) {
3530 int s = android_get_control_socket(service);
3531 if (s < 0) {
3532 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3533 return -1;
3534 }
3535 fcntl(s, F_SETFD, FD_CLOEXEC);
3536
3537 // Set backlog to 0 to make sure that queue size will be minimum.
3538 // In Linux, because the minimum queue will be 1, connect() will be blocked
3539 // if the other clients already called connect() and the connection request was not accepted.
3540 if (listen(s, 0) < 0) {
3541 MYLOGE("listen(control socket): %s\n", strerror(errno));
3542 return -1;
3543 }
3544
3545 struct sockaddr addr;
3546 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003547 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003548
3549 // Close socket just after accept(), to make sure that connect() by client will get error
3550 // when the socket is used by the other services.
3551 // There is still a race condition possibility between accept and close, but there is no way
3552 // to close-on-accept atomically.
3553 // See detail; b/123306389#comment25
3554 close(s);
3555
3556 if (fd < 0) {
3557 MYLOGE("accept(control socket): %s\n", strerror(errno));
3558 return -1;
3559 }
3560
3561 return fd;
3562}
3563
3564/* redirect output to a service control socket */
3565bool redirect_to_socket(FILE* redirect, const char* service) {
3566 int fd = open_socket(service);
3567 if (fd == -1) {
3568 return false;
3569 }
3570 fflush(redirect);
3571 // TODO: handle dup2 failure
3572 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3573 close(fd);
3574 return true;
3575}
3576
3577// TODO: should call is_valid_output_file and/or be merged into it.
3578void create_parent_dirs(const char *path) {
3579 char *chp = const_cast<char *> (path);
3580
3581 /* skip initial slash */
3582 if (chp[0] == '/')
3583 chp++;
3584
3585 /* create leading directories, if necessary */
3586 struct stat dir_stat;
3587 while (chp && chp[0]) {
3588 chp = strchr(chp, '/');
3589 if (chp) {
3590 *chp = 0;
3591 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3592 MYLOGI("Creating directory %s\n", path);
3593 if (mkdir(path, 0770)) { /* drwxrwx--- */
3594 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3595 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3596 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3597 }
3598 }
3599 *chp++ = '/';
3600 }
3601 }
3602}
3603
3604bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3605 create_parent_dirs(path);
3606
3607 int fd = TEMP_FAILURE_RETRY(open(path,
3608 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3609 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3610 if (fd < 0) {
3611 MYLOGE("%s: %s\n", path, strerror(errno));
3612 return false;
3613 }
3614
3615 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3616 close(fd);
3617 return true;
3618}
3619
3620bool redirect_to_file(FILE* redirect, char* path) {
3621 return _redirect_to_file(redirect, path, O_TRUNC);
3622}
3623
3624bool redirect_to_existing_file(FILE* redirect, char* path) {
3625 return _redirect_to_file(redirect, path, O_APPEND);
3626}
3627
3628void dump_route_tables() {
3629 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3630 if (PropertiesHelper::IsDryRun()) return;
3631 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3632 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3633 FILE* fp = fopen(RT_TABLES_PATH, "re");
3634 if (!fp) {
3635 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3636 return;
3637 }
3638 char table[16];
3639 // Each line has an integer (the table number), a space, and a string (the table name). We only
3640 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3641 // Add a fixed max limit so this doesn't go awry.
3642 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3643 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3644 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3645 }
3646 fclose(fp);
3647}
3648
3649// TODO: make this function thread safe if sections are generated in parallel.
3650void Dumpstate::UpdateProgress(int32_t delta_sec) {
3651 if (progress_ == nullptr) {
3652 MYLOGE("UpdateProgress: progress_ not set\n");
3653 return;
3654 }
3655
3656 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003657 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003658
3659 // ...but only notifiy listeners when necessary.
3660 if (!options_->do_progress_updates) return;
3661
3662 int progress = progress_->Get();
3663 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003664 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003665
Nandana Duttf02cd782019-06-14 14:25:13 +01003666 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003667 return;
3668 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003669 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003670
3671 if (control_socket_fd_ >= 0) {
3672 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3673 fsync(control_socket_fd_);
3674 }
3675
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003676 if (listener_ != nullptr) {
3677 if (percent % 5 == 0) {
3678 // We don't want to spam logcat, so only log multiples of 5.
3679 MYLOGD("Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(), progress, max,
3680 percent);
3681 } else {
3682 // stderr is ignored on normal invocations, but useful when calling
3683 // /system/bin/dumpstate directly for debuggging.
3684 fprintf(stderr, "Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(),
3685 progress, max, percent);
3686 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003687
3688 listener_->onProgress(percent);
3689 }
3690}
3691
3692void Dumpstate::TakeScreenshot(const std::string& path) {
3693 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3694 int status =
3695 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3696 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3697 if (status == 0) {
3698 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3699 } else {
3700 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3701 }
3702}
3703
3704bool is_dir(const char* pathname) {
3705 struct stat info;
3706 if (stat(pathname, &info) == -1) {
3707 return false;
3708 }
3709 return S_ISDIR(info.st_mode);
3710}
3711
3712time_t get_mtime(int fd, time_t default_mtime) {
3713 struct stat info;
3714 if (fstat(fd, &info) == -1) {
3715 return default_mtime;
3716 }
3717 return info.st_mtime;
3718}