dumpstate.cpp revision ea1aa91a25f28fb44f36b394e002ede56302eb30
123b797ab5151eb2474f3bdd679f2f07bfd723042John Reck/*
223b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * Copyright (C) 2008 The Android Open Source Project
323b797ab5151eb2474f3bdd679f2f07bfd723042John Reck *
423b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * Licensed under the Apache License, Version 2.0 (the "License");
523b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * you may not use this file except in compliance with the License.
623b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * You may obtain a copy of the License at
723b797ab5151eb2474f3bdd679f2f07bfd723042John Reck *
823b797ab5151eb2474f3bdd679f2f07bfd723042John Reck *      http://www.apache.org/licenses/LICENSE-2.0
923b797ab5151eb2474f3bdd679f2f07bfd723042John Reck *
1023b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * Unless required by applicable law or agreed to in writing, software
1123b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * distributed under the License is distributed on an "AS IS" BASIS,
1223b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1323b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * See the License for the specific language governing permissions and
1423b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * limitations under the License.
1523b797ab5151eb2474f3bdd679f2f07bfd723042John Reck */
1623b797ab5151eb2474f3bdd679f2f07bfd723042John Reck
1723b797ab5151eb2474f3bdd679f2f07bfd723042John Reck#include <dirent.h>
1823b797ab5151eb2474f3bdd679f2f07bfd723042John Reck#include <errno.h>
1923b797ab5151eb2474f3bdd679f2f07bfd723042John Reck#include <fcntl.h>
20ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck#include <libgen.h>
21ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck#include <limits.h>
22ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck#include <memory>
234c9e59d03c2bca38001225b79d01740b8999adfbJohn Reck#include <regex>
24ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck#include <set>
25ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck#include <stdbool.h>
26ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck#include <stdio.h>
27ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck#include <stdlib.h>
28998a6d81896df8b662cc10ddeb35087b78b38d72John Reck#include <string>
2923b797ab5151eb2474f3bdd679f2f07bfd723042John Reck#include <string.h>
3023b797ab5151eb2474f3bdd679f2f07bfd723042John Reck#include <sys/prctl.h>
3119b6bcfd83eb7fb92ebd06d2fec89e308311f1d0John Reck#include <sys/resource.h>
32d04794a9a3f9edc8b7ca336175d66eb81a8f55faJohn Reck#include <sys/stat.h>
334f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck#include <sys/time.h>
344f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck#include <sys/wait.h>
35ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck#include <unistd.h>
36b36016c65f1d1b5846dba0349aab491dbd3a746aJohn Reck
37ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne#include <android-base/stringprintf.h>
3823b797ab5151eb2474f3bdd679f2f07bfd723042John Reck#include <cutils/properties.h>
3923b797ab5151eb2474f3bdd679f2f07bfd723042John Reck
4023b797ab5151eb2474f3bdd679f2f07bfd723042John Reck#include "private/android_filesystem_config.h"
414f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck
42119907cd2575c56b1ebf66348b52e67aaf6a88d8John Reck#define LOG_TAG "dumpstate"
4319b6bcfd83eb7fb92ebd06d2fec89e308311f1d0John Reck#include <cutils/log.h>
444f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck
454f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck#include "dumpstate.h"
461949e7928eeec22cd3f74b5f763a4eb433238453John Reck#include "ScopedFd.h"
47443a714fa7c0dd07fee3527cc5bc3d3ca1fb7d44John Reck#include "ziparchive/zip_writer.h"
484f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck
4923b797ab5151eb2474f3bdd679f2f07bfd723042John Reck#include "mincrypt/sha256.h"
5023b797ab5151eb2474f3bdd679f2f07bfd723042John Reck
513b20251a355c88193c439f928a84ae69483fb488John Reckusing android::base::StringPrintf;
524f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck
531125d1fa92ab9f3b8315bbfb72e038b62dfd454bJohn Reck/* read before root is shed */
541125d1fa92ab9f3b8315bbfb72e038b62dfd454bJohn Reckstatic char cmdline_buf[16384] = "(unknown)";
551125d1fa92ab9f3b8315bbfb72e038b62dfd454bJohn Reckstatic const char *dump_traces_path = NULL;
561125d1fa92ab9f3b8315bbfb72e038b62dfd454bJohn Reck
571125d1fa92ab9f3b8315bbfb72e038b62dfd454bJohn Reck// TODO: should be part of dumpstate object
5823b797ab5151eb2474f3bdd679f2f07bfd723042John Reckstatic unsigned long id;
5923b797ab5151eb2474f3bdd679f2f07bfd723042John Reckstatic char build_type[PROPERTY_VALUE_MAX];
60119907cd2575c56b1ebf66348b52e67aaf6a88d8John Reckstatic time_t now;
61e45b1fd03b524d2b57cc6c222d89076a31a08beaJohn Reckstatic std::unique_ptr<ZipWriter> zip_writer;
6223b797ab5151eb2474f3bdd679f2f07bfd723042John Reckstatic std::set<std::string> mount_points;
63119907cd2575c56b1ebf66348b52e67aaf6a88d8John Reckvoid add_mountinfo();
64119907cd2575c56b1ebf66348b52e67aaf6a88d8John Reckstatic int control_socket_fd;
65e45b1fd03b524d2b57cc6c222d89076a31a08beaJohn Reck/* suffix of the bugreport files - it's typically the date (when invoked with -d),
6623b797ab5151eb2474f3bdd679f2f07bfd723042John Reck * although it could be changed by the user using a system property */
671125d1fa92ab9f3b8315bbfb72e038b62dfd454bJohn Reckstatic std::string suffix;
681125d1fa92ab9f3b8315bbfb72e038b62dfd454bJohn Reck
691125d1fa92ab9f3b8315bbfb72e038b62dfd454bJohn Reck#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
70a5dda645da738da7b4ae15e28fa7d93d3b04b94fJohn Reck
71a5dda645da738da7b4ae15e28fa7d93d3b04b94fJohn Reck#define RAFT_DIR "/data/misc/raft/"
7201a5ea35fbba4c5bb1d7790ae1677a2fa752e042John Reck#define RECOVERY_DIR "/cache/recovery"
73aa95a88327d9a3ac8a4a00b065b78ac0f28b3a19John Reck#define RECOVERY_DATA_DIR "/data/misc/recovery"
74aa95a88327d9a3ac8a4a00b065b78ac0f28b3a19John Reck#define LOGPERSIST_DATA_DIR "/data/misc/logd"
7550210d912925aef14e4ce69be82e4949122a3cd9Alan Viverette#define TOMBSTONE_DIR "/data/tombstones"
76058fc640017c90120c599d378a4cbc55668b05b7Chris Craik#define TOMBSTONE_FILE_PREFIX TOMBSTONE_DIR "/tombstone_"
7750210d912925aef14e4ce69be82e4949122a3cd9Alan Viverette/* Can accomodate a tombstone number up to 9999. */
7863a06673253914510bbeebd500655008682dade1John Reck#define TOMBSTONE_MAX_LEN (sizeof(TOMBSTONE_FILE_PREFIX) + 4)
79860d155f866cc15a725e7ce03763280987f24901John Reck#define NUM_TOMBSTONES  10
8068bfe0a37a0dcef52abd81688d8520c5d16e1a85John Reck#define WLUTIL "/vendor/xbin/wlutil"
81ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne
82ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhnetypedef struct {
83e4267ea4f20740c37c01bfb6aefcf61fddc4566aJohn Reck  char name[TOMBSTONE_MAX_LEN];
8417035b0211a3c9d45ea46a99217a6acbe76e8fbeJohn Reck  int fd;
8523b797ab5151eb2474f3bdd679f2f07bfd723042John Reck} tombstone_data_t;
86e45b1fd03b524d2b57cc6c222d89076a31a08beaJohn Reck
87d41c4d8c732095ae99c955b6b82f7306633004b1Chris Craikstatic tombstone_data_t tombstone_data[NUM_TOMBSTONES];
88ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne
89e45b1fd03b524d2b57cc6c222d89076a31a08beaJohn Reckconst std::string ZIP_ROOT_DIR = "FS";
903e8249568cc428296ac76c7ddce3f0382d40fe5bJohn Reckstd::string bugreport_dir;
9119b6bcfd83eb7fb92ebd06d2fec89e308311f1d0John Reck
92998a6d81896df8b662cc10ddeb35087b78b38d72John Reck/*
9319b6bcfd83eb7fb92ebd06d2fec89e308311f1d0John Reck * List of supported zip format versions.
94f47a594f5250b1914c36423ee6b371f0b8db09d0John Reck *
95f47a594f5250b1914c36423ee6b371f0b8db09d0John Reck * See bugreport-format.txt for more info.
96e1628b7c6fc3822fa83cf02028ce8ad67abb0afeJohn Reck */
973b20251a355c88193c439f928a84ae69483fb488John Reckstatic std::string VERSION_DEFAULT = "1.0";
9823b797ab5151eb2474f3bdd679f2f07bfd723042John Reck
99fc53ef27793a39e9effd829e9cae02a9ca14147eJohn Reckbool is_user_build() {
100fc53ef27793a39e9effd829e9cae02a9ca14147eJohn Reck    return 0 == strncmp(build_type, "user", PROPERTY_VALUE_MAX - 1);
1011949e7928eeec22cd3f74b5f763a4eb433238453John Reck}
1021949e7928eeec22cd3f74b5f763a4eb433238453John Reck
1033b20251a355c88193c439f928a84ae69483fb488John Reck/* gets the tombstone data, according to the bugreport type: if zipped gets all tombstones,
1043b20251a355c88193c439f928a84ae69483fb488John Reck * otherwise gets just those modified in the last half an hour. */
10566f0be65a1046f54ddce0498b242c1fa0776b1eaJohn Reckstatic void get_tombstone_fds(tombstone_data_t data[NUM_TOMBSTONES]) {
106f47a594f5250b1914c36423ee6b371f0b8db09d0John Reck    time_t thirty_minutes_ago = now - 60*30;
107a5dda645da738da7b4ae15e28fa7d93d3b04b94fJohn Reck    for (size_t i = 0; i < NUM_TOMBSTONES; i++) {
108a5dda645da738da7b4ae15e28fa7d93d3b04b94fJohn Reck        snprintf(data[i].name, sizeof(data[i].name), "%s%02zu", TOMBSTONE_FILE_PREFIX, i);
1094c9e59d03c2bca38001225b79d01740b8999adfbJohn Reck        int fd = TEMP_FAILURE_RETRY(open(data[i].name,
110fe5e7b7346a54537b980796ceeca66bfdbd05561John Reck                                         O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK));
111ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck        struct stat st;
112ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck        if (fstat(fd, &st) == 0 && S_ISREG(st.st_mode) &&
113ba6adf66d3c44c0aa2fd8a224862ff1901d64300John Reck            (zip_writer || (time_t) st.st_mtime >= thirty_minutes_ago)) {
114b36016c65f1d1b5846dba0349aab491dbd3a746aJohn Reck        data[i].fd = fd;
115b36016c65f1d1b5846dba0349aab491dbd3a746aJohn Reck        } else {
116b36016c65f1d1b5846dba0349aab491dbd3a746aJohn Reck        close(fd);
117e248bd1b2c3fcf8088429507e73b31f45ee2544bJohn Reck            data[i].fd = -1;
118e248bd1b2c3fcf8088429507e73b31f45ee2544bJohn Reck        }
119ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne    }
120ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne}
121ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne
122ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne// for_each_pid() callback to get mount info about a process.
123ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhnevoid do_mountinfo(int pid, const char *name) {
124ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne    char path[PATH_MAX];
125ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne
126ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne    // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
127ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne    // are added.
128ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne    snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
129ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne    char linkname[PATH_MAX];
130ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne    ssize_t r = readlink(path, linkname, PATH_MAX);
131ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne    if (r == -1) {
132ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne        MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
13323b797ab5151eb2474f3bdd679f2f07bfd723042John Reck        return;
134a5dda645da738da7b4ae15e28fa7d93d3b04b94fJohn Reck    }
135443a714fa7c0dd07fee3527cc5bc3d3ca1fb7d44John Reck    linkname[r] = '\0';
136443a714fa7c0dd07fee3527cc5bc3d3ca1fb7d44John Reck
137443a714fa7c0dd07fee3527cc5bc3d3ca1fb7d44John Reck    if (mount_points.find(linkname) == mount_points.end()) {
138a5dda645da738da7b4ae15e28fa7d93d3b04b94fJohn Reck        // First time this mount point was found: add it
139a5dda645da738da7b4ae15e28fa7d93d3b04b94fJohn Reck        snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
140f7d9c1dc84671d4e99657ef071d275700d85bb11John Reck        if (add_zip_entry(ZIP_ROOT_DIR + path, path)) {
1414f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck            mount_points.insert(linkname);
142998a6d81896df8b662cc10ddeb35087b78b38d72John Reck        } else {
143998a6d81896df8b662cc10ddeb35087b78b38d72John Reck            MYLOGE("Unable to add mountinfo %s to zip file\n", path);
1444f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck        }
1453b20251a355c88193c439f928a84ae69483fb488John Reck    }
146a5dda645da738da7b4ae15e28fa7d93d3b04b94fJohn Reck}
147edc524c90506d80e0fc5fb67e8de7b8f3ef53439John Reck
148edc524c90506d80e0fc5fb67e8de7b8f3ef53439John Reckvoid add_mountinfo() {
149edc524c90506d80e0fc5fb67e8de7b8f3ef53439John Reck    if (!zip_writer) return;
150149173d28c0843aba86b0810ce75b34be6a0d08fJohn Reck    const char *title = "MOUNT INFO";
1514f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck    mount_points.clear();
1524f02bf4eef6af47f35c70c4dda5b7b9523d89ca0John Reck    DurationReporter duration_reporter(title, NULL);
153edc524c90506d80e0fc5fb67e8de7b8f3ef53439John Reck    for_each_pid(do_mountinfo, NULL);
154edc524c90506d80e0fc5fb67e8de7b8f3ef53439John Reck    MYLOGD("%s: %d entries added to zip file\n", title, (int) mount_points.size());
155e4267ea4f20740c37c01bfb6aefcf61fddc4566aJohn Reck}
15651d6a3db97bdd5315f1a17a4b447d10a92217b98Chris Craik
157e45b1fd03b524d2b57cc6c222d89076a31a08beaJohn Reckstatic void dump_dev_files(const char *title, const char *driverpath, const char *filename)
158ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne{
159fe5e7b7346a54537b980796ceeca66bfdbd05561John Reck    DIR *d;
160edc524c90506d80e0fc5fb67e8de7b8f3ef53439John Reck    struct dirent *de;
1614c9e59d03c2bca38001225b79d01740b8999adfbJohn Reck    char path[PATH_MAX];
1624c9e59d03c2bca38001225b79d01740b8999adfbJohn Reck
163b36016c65f1d1b5846dba0349aab491dbd3a746aJohn Reck    d = opendir(driverpath);
164edc524c90506d80e0fc5fb67e8de7b8f3ef53439John Reck    if (d == NULL) {
1654c9e59d03c2bca38001225b79d01740b8999adfbJohn Reck        return;
166998a6d81896df8b662cc10ddeb35087b78b38d72John Reck    }
167998a6d81896df8b662cc10ddeb35087b78b38d72John Reck
168ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne    while ((de = readdir(d))) {
169ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne        if (de->d_type != DT_LNK) {
170ea7a7fb75acb7305eb774ca7bc7e96103bd49323Skuhne            continue;
17123b797ab5151eb2474f3bdd679f2f07bfd723042John Reck        }
17223b797ab5151eb2474f3bdd679f2f07bfd723042John Reck        snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
17323b797ab5151eb2474f3bdd679f2f07bfd723042John Reck        dump_file(title, path);
17423b797ab5151eb2474f3bdd679f2f07bfd723042John Reck    }
17523b797ab5151eb2474f3bdd679f2f07bfd723042John Reck
17623b797ab5151eb2474f3bdd679f2f07bfd723042John Reck    closedir(d);
177}
178
179static void dump_systrace() {
180    if (!zip_writer) {
181        MYLOGD("Not dumping systrace because zip_writer is not set\n");
182        return;
183    }
184    std::string systrace_path = bugreport_dir + "/systrace-" + suffix + ".txt";
185    if (systrace_path.empty()) {
186        MYLOGE("Not dumping systrace because path is empty\n");
187        return;
188    }
189    const char* path = "/sys/kernel/debug/tracing/tracing_on";
190    long int is_tracing;
191    if (read_file_as_long(path, &is_tracing)) {
192        return; // error already logged
193    }
194    if (is_tracing <= 0) {
195        MYLOGD("Skipping systrace because '%s' content is '%ld'\n", path, is_tracing);
196        return;
197    }
198
199    MYLOGD("Running '/system/bin/atrace --async_dump -o %s', which can take several minutes",
200            systrace_path.c_str());
201    if (run_command("SYSTRACE", 120, "/system/bin/atrace", "--async_dump", "-o",
202            systrace_path.c_str(), NULL)) {
203        MYLOGE("systrace timed out, its zip entry will be incomplete\n");
204        // TODO: run_command tries to kill the process, but atrace doesn't die peacefully; ideally,
205        // we should call strace to stop itself, but there is no such option yet (just a
206        // --async_stop, which stops and dump
207        //        if (run_command("SYSTRACE", 10, "/system/bin/atrace", "--kill", NULL)) {
208        //            MYLOGE("could not stop systrace ");
209        //        }
210    }
211    if (!add_zip_entry("systrace.txt", systrace_path)) {
212        MYLOGE("Unable to add systrace file %s to zip file\n", systrace_path.c_str());
213    } else {
214        if (remove(systrace_path.c_str())) {
215            MYLOGE("Error removing systrace file %s: %s", systrace_path.c_str(), strerror(errno));
216        }
217    }
218}
219
220static bool skip_not_stat(const char *path) {
221    static const char stat[] = "/stat";
222    size_t len = strlen(path);
223    if (path[len - 1] == '/') { /* Directory? */
224        return false;
225    }
226    return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
227}
228
229static bool skip_none(const char *path) {
230    return false;
231}
232
233static const char mmcblk0[] = "/sys/block/mmcblk0/";
234unsigned long worst_write_perf = 20000; /* in KB/s */
235
236//
237//  stat offsets
238// Name            units         description
239// ----            -----         -----------
240// read I/Os       requests      number of read I/Os processed
241#define __STAT_READ_IOS      0
242// read merges     requests      number of read I/Os merged with in-queue I/O
243#define __STAT_READ_MERGES   1
244// read sectors    sectors       number of sectors read
245#define __STAT_READ_SECTORS  2
246// read ticks      milliseconds  total wait time for read requests
247#define __STAT_READ_TICKS    3
248// write I/Os      requests      number of write I/Os processed
249#define __STAT_WRITE_IOS     4
250// write merges    requests      number of write I/Os merged with in-queue I/O
251#define __STAT_WRITE_MERGES  5
252// write sectors   sectors       number of sectors written
253#define __STAT_WRITE_SECTORS 6
254// write ticks     milliseconds  total wait time for write requests
255#define __STAT_WRITE_TICKS   7
256// in_flight       requests      number of I/Os currently in flight
257#define __STAT_IN_FLIGHT     8
258// io_ticks        milliseconds  total time this block device has been active
259#define __STAT_IO_TICKS      9
260// time_in_queue   milliseconds  total wait time for all requests
261#define __STAT_IN_QUEUE     10
262#define __STAT_NUMBER_FIELD 11
263//
264// read I/Os, write I/Os
265// =====================
266//
267// These values increment when an I/O request completes.
268//
269// read merges, write merges
270// =========================
271//
272// These values increment when an I/O request is merged with an
273// already-queued I/O request.
274//
275// read sectors, write sectors
276// ===========================
277//
278// These values count the number of sectors read from or written to this
279// block device.  The "sectors" in question are the standard UNIX 512-byte
280// sectors, not any device- or filesystem-specific block size.  The
281// counters are incremented when the I/O completes.
282#define SECTOR_SIZE 512
283//
284// read ticks, write ticks
285// =======================
286//
287// These values count the number of milliseconds that I/O requests have
288// waited on this block device.  If there are multiple I/O requests waiting,
289// these values will increase at a rate greater than 1000/second; for
290// example, if 60 read requests wait for an average of 30 ms, the read_ticks
291// field will increase by 60*30 = 1800.
292//
293// in_flight
294// =========
295//
296// This value counts the number of I/O requests that have been issued to
297// the device driver but have not yet completed.  It does not include I/O
298// requests that are in the queue but not yet issued to the device driver.
299//
300// io_ticks
301// ========
302//
303// This value counts the number of milliseconds during which the device has
304// had I/O requests queued.
305//
306// time_in_queue
307// =============
308//
309// This value counts the number of milliseconds that I/O requests have waited
310// on this block device.  If there are multiple I/O requests waiting, this
311// value will increase as the product of the number of milliseconds times the
312// number of requests waiting (see "read ticks" above for an example).
313#define S_TO_MS 1000
314//
315
316static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
317    unsigned long long fields[__STAT_NUMBER_FIELD];
318    bool z;
319    char *cp, *buffer = NULL;
320    size_t i = 0;
321    FILE *fp = fdopen(fd, "rb");
322    getline(&buffer, &i, fp);
323    fclose(fp);
324    if (!buffer) {
325        return -errno;
326    }
327    i = strlen(buffer);
328    while ((i > 0) && (buffer[i - 1] == '\n')) {
329        buffer[--i] = '\0';
330    }
331    if (!*buffer) {
332        free(buffer);
333        return 0;
334    }
335    z = true;
336    for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
337        fields[i] = strtoull(cp, &cp, 10);
338        if (fields[i] != 0) {
339            z = false;
340        }
341    }
342    if (z) { /* never accessed */
343        free(buffer);
344        return 0;
345    }
346
347    if (!strncmp(path, mmcblk0, sizeof(mmcblk0) - 1)) {
348        path += sizeof(mmcblk0) - 1;
349    }
350
351    printf("%s: %s\n", path, buffer);
352    free(buffer);
353
354    if (fields[__STAT_IO_TICKS]) {
355        unsigned long read_perf = 0;
356        unsigned long read_ios = 0;
357        if (fields[__STAT_READ_TICKS]) {
358            unsigned long long divisor = fields[__STAT_READ_TICKS]
359                                       * fields[__STAT_IO_TICKS];
360            read_perf = ((unsigned long long)SECTOR_SIZE
361                           * fields[__STAT_READ_SECTORS]
362                           * fields[__STAT_IN_QUEUE] + (divisor >> 1))
363                                        / divisor;
364            read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
365                           * fields[__STAT_IN_QUEUE] + (divisor >> 1))
366                                        / divisor;
367        }
368
369        unsigned long write_perf = 0;
370        unsigned long write_ios = 0;
371        if (fields[__STAT_WRITE_TICKS]) {
372            unsigned long long divisor = fields[__STAT_WRITE_TICKS]
373                                       * fields[__STAT_IO_TICKS];
374            write_perf = ((unsigned long long)SECTOR_SIZE
375                           * fields[__STAT_WRITE_SECTORS]
376                           * fields[__STAT_IN_QUEUE] + (divisor >> 1))
377                                        / divisor;
378            write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
379                           * fields[__STAT_IN_QUEUE] + (divisor >> 1))
380                                        / divisor;
381        }
382
383        unsigned queue = (fields[__STAT_IN_QUEUE]
384                             + (fields[__STAT_IO_TICKS] >> 1))
385                                 / fields[__STAT_IO_TICKS];
386
387        if (!write_perf && !write_ios) {
388            printf("%s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n",
389                   path, read_perf, read_ios, queue);
390        } else {
391            printf("%s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n",
392                   path, read_perf, read_ios, write_perf, write_ios, queue);
393        }
394
395        /* bugreport timeout factor adjustment */
396        if ((write_perf > 1) && (write_perf < worst_write_perf)) {
397            worst_write_perf = write_perf;
398        }
399    }
400    return 0;
401}
402
403/* Copied policy from system/core/logd/LogBuffer.cpp */
404
405#define LOG_BUFFER_SIZE (256 * 1024)
406#define LOG_BUFFER_MIN_SIZE (64 * 1024UL)
407#define LOG_BUFFER_MAX_SIZE (256 * 1024 * 1024UL)
408
409static bool valid_size(unsigned long value) {
410    if ((value < LOG_BUFFER_MIN_SIZE) || (LOG_BUFFER_MAX_SIZE < value)) {
411        return false;
412    }
413
414    long pages = sysconf(_SC_PHYS_PAGES);
415    if (pages < 1) {
416        return true;
417    }
418
419    long pagesize = sysconf(_SC_PAGESIZE);
420    if (pagesize <= 1) {
421        pagesize = PAGE_SIZE;
422    }
423
424    // maximum memory impact a somewhat arbitrary ~3%
425    pages = (pages + 31) / 32;
426    unsigned long maximum = pages * pagesize;
427
428    if ((maximum < LOG_BUFFER_MIN_SIZE) || (LOG_BUFFER_MAX_SIZE < maximum)) {
429        return true;
430    }
431
432    return value <= maximum;
433}
434
435static unsigned long property_get_size(const char *key) {
436    unsigned long value;
437    char *cp, property[PROPERTY_VALUE_MAX];
438
439    property_get(key, property, "");
440    value = strtoul(property, &cp, 10);
441
442    switch(*cp) {
443    case 'm':
444    case 'M':
445        value *= 1024;
446    /* FALLTHRU */
447    case 'k':
448    case 'K':
449        value *= 1024;
450    /* FALLTHRU */
451    case '\0':
452        break;
453
454    default:
455        value = 0;
456    }
457
458    if (!valid_size(value)) {
459        value = 0;
460    }
461
462    return value;
463}
464
465/* timeout in ms */
466static unsigned long logcat_timeout(const char *name) {
467    static const char global_tuneable[] = "persist.logd.size"; // Settings App
468    static const char global_default[] = "ro.logd.size";       // BoardConfig.mk
469    char key[PROP_NAME_MAX];
470    unsigned long property_size, default_size;
471
472    default_size = property_get_size(global_tuneable);
473    if (!default_size) {
474        default_size = property_get_size(global_default);
475    }
476
477    snprintf(key, sizeof(key), "%s.%s", global_tuneable, name);
478    property_size = property_get_size(key);
479
480    if (!property_size) {
481        snprintf(key, sizeof(key), "%s.%s", global_default, name);
482        property_size = property_get_size(key);
483    }
484
485    if (!property_size) {
486        property_size = default_size;
487    }
488
489    if (!property_size) {
490        property_size = LOG_BUFFER_SIZE;
491    }
492
493    /* Engineering margin is ten-fold our guess */
494    return 10 * (property_size + worst_write_perf) / worst_write_perf;
495}
496
497/* End copy from system/core/logd/LogBuffer.cpp */
498
499/* dumps the current system state to stdout */
500static void print_header(std::string version) {
501    char build[PROPERTY_VALUE_MAX], fingerprint[PROPERTY_VALUE_MAX];
502    char radio[PROPERTY_VALUE_MAX], bootloader[PROPERTY_VALUE_MAX];
503    char network[PROPERTY_VALUE_MAX], date[80];
504
505    property_get("ro.build.display.id", build, "(unknown)");
506    property_get("ro.build.fingerprint", fingerprint, "(unknown)");
507    property_get("ro.build.type", build_type, "(unknown)");
508    property_get("ro.baseband", radio, "(unknown)");
509    property_get("ro.bootloader", bootloader, "(unknown)");
510    property_get("gsm.operator.alpha", network, "(unknown)");
511    strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now));
512
513    printf("========================================================\n");
514    printf("== dumpstate: %s\n", date);
515    printf("========================================================\n");
516
517    printf("\n");
518    printf("Build: %s\n", build);
519    printf("Build fingerprint: '%s'\n", fingerprint); /* format is important for other tools */
520    printf("Bootloader: %s\n", bootloader);
521    printf("Radio: %s\n", radio);
522    printf("Network: %s\n", network);
523
524    printf("Kernel: ");
525    dump_file(NULL, "/proc/version");
526    printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
527    printf("Bugreport format version: %s\n", version.c_str());
528    printf("Dumpstate info: id=%lu pid=%d\n", id, getpid());
529    printf("\n");
530}
531
532bool add_zip_entry_from_fd(const std::string& entry_name, int fd) {
533    if (!zip_writer) {
534        MYLOGD("Not adding zip entry %s from fd because zip_writer is not set\n",
535                entry_name.c_str());
536        return false;
537    }
538    // Logging statement  below is useful to time how long each entry takes, but it's too verbose.
539    // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
540    int32_t err = zip_writer->StartEntryWithTime(entry_name.c_str(),
541            ZipWriter::kCompress, get_mtime(fd, now));
542    if (err) {
543        MYLOGE("zip_writer->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
544                ZipWriter::ErrorCodeString(err));
545        return false;
546    }
547
548    std::vector<uint8_t> buffer(65536);
549    while (1) {
550        ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), sizeof(buffer)));
551        if (bytes_read == 0) {
552            break;
553        } else if (bytes_read == -1) {
554            MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
555            return false;
556        }
557        err = zip_writer->WriteBytes(buffer.data(), bytes_read);
558        if (err) {
559            MYLOGE("zip_writer->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
560            return false;
561        }
562    }
563
564    err = zip_writer->FinishEntry();
565    if (err) {
566        MYLOGE("zip_writer->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
567        return false;
568    }
569
570    return true;
571}
572
573bool add_zip_entry(const std::string& entry_name, const std::string& entry_path) {
574    ScopedFd fd(TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
575    if (fd.get() == -1) {
576        MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
577        return false;
578    }
579
580    return add_zip_entry_from_fd(entry_name, fd.get());
581}
582
583/* adds a file to the existing zipped bugreport */
584static int _add_file_from_fd(const char *title, const char *path, int fd) {
585    return add_zip_entry_from_fd(ZIP_ROOT_DIR + path, fd) ? 0 : 1;
586}
587
588void add_dir(const char *dir, bool recursive) {
589    if (!zip_writer) {
590        MYLOGD("Not adding dir %s because zip_writer is not set\n", dir);
591        return;
592    }
593    MYLOGD("Adding dir %s (recursive: %d)\n", dir, recursive);
594    DurationReporter duration_reporter(dir, NULL);
595    dump_files(NULL, dir, recursive ? skip_none : is_dir, _add_file_from_fd);
596}
597
598/* adds a text entry entry to the existing zip file. */
599static bool add_text_zip_entry(const std::string& entry_name, const std::string& content) {
600    if (!zip_writer) {
601        MYLOGD("Not adding text zip entry %s because zip_writer is not set\n", entry_name.c_str());
602        return false;
603    }
604    MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
605    int32_t err = zip_writer->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, now);
606    if (err) {
607        MYLOGE("zip_writer->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
608                ZipWriter::ErrorCodeString(err));
609        return false;
610    }
611
612    err = zip_writer->WriteBytes(content.c_str(), content.length());
613    if (err) {
614        MYLOGE("zip_writer->WriteBytes(%s): %s\n", entry_name.c_str(),
615                ZipWriter::ErrorCodeString(err));
616        return false;
617    }
618
619    err = zip_writer->FinishEntry();
620    if (err) {
621        MYLOGE("zip_writer->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
622        return false;
623    }
624
625    return true;
626}
627
628static void dumpstate(const std::string& screenshot_path, const std::string& version) {
629    DurationReporter duration_reporter("DUMPSTATE");
630    unsigned long timeout;
631
632    dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
633    run_command("UPTIME", 10, "uptime", NULL);
634    dump_files("UPTIME MMC PERF", mmcblk0, skip_not_stat, dump_stat_from_fd);
635    dump_emmc_ecsd("/d/mmc0/mmc0:0001/ext_csd");
636    dump_file("MEMORY INFO", "/proc/meminfo");
637    run_command("CPU INFO", 10, "top", "-n", "1", "-d", "1", "-m", "30", "-H", NULL);
638    run_command("PROCRANK", 20, SU_PATH, "root", "procrank", NULL);
639    dump_file("VIRTUAL MEMORY STATS", "/proc/vmstat");
640    dump_file("VMALLOC INFO", "/proc/vmallocinfo");
641    dump_file("SLAB INFO", "/proc/slabinfo");
642    dump_file("ZONEINFO", "/proc/zoneinfo");
643    dump_file("PAGETYPEINFO", "/proc/pagetypeinfo");
644    dump_file("BUDDYINFO", "/proc/buddyinfo");
645    dump_file("FRAGMENTATION INFO", "/d/extfrag/unusable_index");
646
647    dump_file("KERNEL WAKE SOURCES", "/d/wakeup_sources");
648    dump_file("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
649    dump_file("KERNEL SYNC", "/d/sync");
650
651    run_command("PROCESSES AND THREADS", 10, "ps", "-Z", "-t", "-p", "-P", NULL);
652    run_command("LIBRANK", 10, SU_PATH, "root", "librank", NULL);
653
654    run_command("PRINTENV", 10, "printenv", NULL);
655    run_command("NETSTAT", 10, "netstat", "-n", NULL);
656    run_command("LSMOD", 10, "lsmod", NULL);
657
658    do_dmesg();
659
660    run_command("LIST OF OPEN FILES", 10, SU_PATH, "root", "lsof", NULL);
661    for_each_pid(do_showmap, "SMAPS OF ALL PROCESSES");
662    for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
663    for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
664
665    if (!screenshot_path.empty()) {
666        MYLOGI("taking late screenshot\n");
667        take_screenshot(screenshot_path);
668        MYLOGI("wrote screenshot: %s\n", screenshot_path.c_str());
669    }
670
671    // dump_file("EVENT LOG TAGS", "/etc/event-log-tags");
672    // calculate timeout
673    timeout = logcat_timeout("main") + logcat_timeout("system") + logcat_timeout("crash");
674    if (timeout < 20000) {
675        timeout = 20000;
676    }
677    run_command("SYSTEM LOG", timeout / 1000, "logcat", "-v", "threadtime",
678                                                        "-v", "printable",
679                                                        "-d",
680                                                        "*:v", NULL);
681    timeout = logcat_timeout("events");
682    if (timeout < 20000) {
683        timeout = 20000;
684    }
685    run_command("EVENT LOG", timeout / 1000, "logcat", "-b", "events",
686                                                       "-v", "threadtime",
687                                                       "-v", "printable",
688                                                       "-d",
689                                                       "*:v", NULL);
690    timeout = logcat_timeout("radio");
691    if (timeout < 20000) {
692        timeout = 20000;
693    }
694    run_command("RADIO LOG", timeout / 1000, "logcat", "-b", "radio",
695                                                       "-v", "threadtime",
696                                                       "-v", "printable",
697                                                       "-d",
698                                                       "*:v", NULL);
699
700    run_command("LOG STATISTICS", 10, "logcat", "-b", "all", "-S", NULL);
701
702    run_command("RAFT LOGS", 600, SU_PATH, "root", "logcompressor", "-r", RAFT_DIR, NULL);
703
704    /* show the traces we collected in main(), if that was done */
705    if (dump_traces_path != NULL) {
706        dump_file("VM TRACES JUST NOW", dump_traces_path);
707    }
708
709    /* only show ANR traces if they're less than 15 minutes old */
710    struct stat st;
711    char anr_traces_path[PATH_MAX];
712    property_get("dalvik.vm.stack-trace-file", anr_traces_path, "");
713    if (!anr_traces_path[0]) {
714        printf("*** NO VM TRACES FILE DEFINED (dalvik.vm.stack-trace-file)\n\n");
715    } else {
716      int fd = TEMP_FAILURE_RETRY(open(anr_traces_path,
717                                       O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK));
718      if (fd < 0) {
719          printf("*** NO ANR VM TRACES FILE (%s): %s\n\n", anr_traces_path, strerror(errno));
720      } else {
721          dump_file_from_fd("VM TRACES AT LAST ANR", anr_traces_path, fd);
722      }
723    }
724
725    /* slow traces for slow operations */
726    if (anr_traces_path[0] != 0) {
727        int tail = strlen(anr_traces_path)-1;
728        while (tail > 0 && anr_traces_path[tail] != '/') {
729            tail--;
730        }
731        int i = 0;
732        while (1) {
733            sprintf(anr_traces_path+tail+1, "slow%02d.txt", i);
734            if (stat(anr_traces_path, &st)) {
735                // No traces file at this index, done with the files.
736                break;
737            }
738            dump_file("VM TRACES WHEN SLOW", anr_traces_path);
739            i++;
740        }
741    }
742
743    int dumped = 0;
744    for (size_t i = 0; i < NUM_TOMBSTONES; i++) {
745        if (tombstone_data[i].fd != -1) {
746            const char *name = tombstone_data[i].name;
747            int fd = tombstone_data[i].fd;
748            dumped = 1;
749            if (zip_writer) {
750                if (!add_zip_entry_from_fd(ZIP_ROOT_DIR + name, fd)) {
751                    MYLOGE("Unable to add tombstone %s to zip file\n", name);
752                }
753            } else {
754                dump_file_from_fd("TOMBSTONE", name, fd);
755            }
756            close(fd);
757            tombstone_data[i].fd = -1;
758        }
759    }
760    if (!dumped) {
761        printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR);
762    }
763
764    dump_file("NETWORK DEV INFO", "/proc/net/dev");
765    dump_file("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
766    dump_file("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
767    dump_file("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
768    dump_file("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
769
770    if (!stat(PSTORE_LAST_KMSG, &st)) {
771        /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
772        dump_file("LAST KMSG", PSTORE_LAST_KMSG);
773    } else {
774        /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
775        dump_file("LAST KMSG", "/proc/last_kmsg");
776    }
777
778    /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
779    run_command("LAST LOGCAT", 10, "logcat", "-L",
780                                             "-b", "all",
781                                             "-v", "threadtime",
782                                             "-v", "printable",
783                                             "-d",
784                                             "*:v", NULL);
785
786    /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
787
788    run_command("NETWORK INTERFACES", 10, "ip", "link", NULL);
789
790    run_command("IPv4 ADDRESSES", 10, "ip", "-4", "addr", "show", NULL);
791    run_command("IPv6 ADDRESSES", 10, "ip", "-6", "addr", "show", NULL);
792
793    run_command("IP RULES", 10, "ip", "rule", "show", NULL);
794    run_command("IP RULES v6", 10, "ip", "-6", "rule", "show", NULL);
795
796    dump_route_tables();
797
798    run_command("ARP CACHE", 10, "ip", "-4", "neigh", "show", NULL);
799    run_command("IPv6 ND CACHE", 10, "ip", "-6", "neigh", "show", NULL);
800    run_command("MULTICAST ADDRESSES", 10, "ip", "maddr", NULL);
801
802    run_command("IPTABLES", 10, SU_PATH, "root", "iptables", "-L", "-nvx", NULL);
803    run_command("IP6TABLES", 10, SU_PATH, "root", "ip6tables", "-L", "-nvx", NULL);
804    run_command("IPTABLE NAT", 10, SU_PATH, "root", "iptables", "-t", "nat", "-L", "-nvx", NULL);
805    /* no ip6 nat */
806    run_command("IPTABLE RAW", 10, SU_PATH, "root", "iptables", "-t", "raw", "-L", "-nvx", NULL);
807    run_command("IP6TABLE RAW", 10, SU_PATH, "root", "ip6tables", "-t", "raw", "-L", "-nvx", NULL);
808
809    run_command("WIFI NETWORKS", 20,
810            SU_PATH, "root", "wpa_cli", "IFNAME=wlan0", "list_networks", NULL);
811
812#ifdef FWDUMP_bcmdhd
813    run_command("ND OFFLOAD TABLE", 5,
814            SU_PATH, "root", WLUTIL, "nd_hostip", NULL);
815
816    run_command("DUMP WIFI INTERNAL COUNTERS (1)", 20,
817            SU_PATH, "root", WLUTIL, "counters", NULL);
818
819    run_command("ND OFFLOAD STATUS (1)", 5,
820            SU_PATH, "root", WLUTIL, "nd_status", NULL);
821
822#endif
823    dump_file("INTERRUPTS (1)", "/proc/interrupts");
824
825    run_command("NETWORK DIAGNOSTICS", 10, "dumpsys", "-t", "10", "connectivity", "--diag", NULL);
826
827#ifdef FWDUMP_bcmdhd
828    run_command("DUMP WIFI STATUS", 20,
829            SU_PATH, "root", "dhdutil", "-i", "wlan0", "dump", NULL);
830
831    run_command("DUMP WIFI INTERNAL COUNTERS (2)", 20,
832            SU_PATH, "root", WLUTIL, "counters", NULL);
833
834    run_command("ND OFFLOAD STATUS (2)", 5,
835            SU_PATH, "root", WLUTIL, "nd_status", NULL);
836#endif
837    dump_file("INTERRUPTS (2)", "/proc/interrupts");
838
839    print_properties();
840
841    run_command("VOLD DUMP", 10, "vdc", "dump", NULL);
842    run_command("SECURE CONTAINERS", 10, "vdc", "asec", "list", NULL);
843
844    run_command("FILESYSTEMS & FREE SPACE", 10, "df", NULL);
845
846    run_command("LAST RADIO LOG", 10, "parse_radio_log", "/proc/last_radio_log", NULL);
847
848    printf("------ BACKLIGHTS ------\n");
849    printf("LCD brightness=");
850    dump_file(NULL, "/sys/class/leds/lcd-backlight/brightness");
851    printf("Button brightness=");
852    dump_file(NULL, "/sys/class/leds/button-backlight/brightness");
853    printf("Keyboard brightness=");
854    dump_file(NULL, "/sys/class/leds/keyboard-backlight/brightness");
855    printf("ALS mode=");
856    dump_file(NULL, "/sys/class/leds/lcd-backlight/als");
857    printf("LCD driver registers:\n");
858    dump_file(NULL, "/sys/class/leds/lcd-backlight/registers");
859    printf("\n");
860
861    /* Binder state is expensive to look at as it uses a lot of memory. */
862    dump_file("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
863    dump_file("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
864    dump_file("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
865    dump_file("BINDER STATS", "/sys/kernel/debug/binder/stats");
866    dump_file("BINDER STATE", "/sys/kernel/debug/binder/state");
867
868    printf("========================================================\n");
869    printf("== Board\n");
870    printf("========================================================\n");
871
872    dumpstate_board();
873    printf("\n");
874
875    /* Migrate the ril_dumpstate to a dumpstate_board()? */
876    char ril_dumpstate_timeout[PROPERTY_VALUE_MAX] = {0};
877    property_get("ril.dumpstate.timeout", ril_dumpstate_timeout, "30");
878    if (strnlen(ril_dumpstate_timeout, PROPERTY_VALUE_MAX - 1) > 0) {
879        if (is_user_build()) {
880            // su does not exist on user builds, so try running without it.
881            // This way any implementations of vril-dump that do not require
882            // root can run on user builds.
883            run_command("DUMP VENDOR RIL LOGS", atoi(ril_dumpstate_timeout),
884                    "vril-dump", NULL);
885        } else {
886            run_command("DUMP VENDOR RIL LOGS", atoi(ril_dumpstate_timeout),
887                    SU_PATH, "root", "vril-dump", NULL);
888        }
889    }
890
891    printf("========================================================\n");
892    printf("== Android Framework Services\n");
893    printf("========================================================\n");
894
895    run_command("DUMPSYS", 60, "dumpsys", "-t", "60", "--skip", "meminfo", "cpuinfo", NULL);
896
897    printf("========================================================\n");
898    printf("== Checkins\n");
899    printf("========================================================\n");
900
901    run_command("CHECKIN BATTERYSTATS", 30, "dumpsys", "-t", "30", "batterystats", "-c", NULL);
902    run_command("CHECKIN MEMINFO", 30, "dumpsys", "-t", "30", "meminfo", "--checkin", NULL);
903    run_command("CHECKIN NETSTATS", 30, "dumpsys", "-t", "30", "netstats", "--checkin", NULL);
904    run_command("CHECKIN PROCSTATS", 30, "dumpsys", "-t", "30", "procstats", "-c", NULL);
905    run_command("CHECKIN USAGESTATS", 30, "dumpsys", "-t", "30", "usagestats", "-c", NULL);
906    run_command("CHECKIN PACKAGE", 30, "dumpsys", "-t", "30", "package", "--checkin", NULL);
907
908    printf("========================================================\n");
909    printf("== Running Application Activities\n");
910    printf("========================================================\n");
911
912    run_command("APP ACTIVITIES", 30, "dumpsys", "-t", "30", "activity", "all", NULL);
913
914    printf("========================================================\n");
915    printf("== Running Application Services\n");
916    printf("========================================================\n");
917
918    run_command("APP SERVICES", 30, "dumpsys", "-t", "30", "activity", "service", "all", NULL);
919
920    printf("========================================================\n");
921    printf("== Running Application Providers\n");
922    printf("========================================================\n");
923
924    run_command("APP SERVICES", 30, "dumpsys", "-t", "30", "activity", "provider", "all", NULL);
925
926
927    printf("========================================================\n");
928    printf("== Final progress (pid %d): %d/%d (originally %d)\n",
929            getpid(), progress, weight_total, WEIGHT_TOTAL);
930    printf("========================================================\n");
931    printf("== dumpstate: done\n");
932    printf("========================================================\n");
933}
934
935static void usage() {
936  fprintf(stderr,
937          "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o file [-d] [-p] "
938          "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
939          "  -h: display this help message\n"
940          "  -b: play sound file instead of vibrate, at beginning of job\n"
941          "  -e: play sound file instead of vibrate, at end of job\n"
942          "  -o: write to file (instead of stdout)\n"
943          "  -d: append date to filename (requires -o)\n"
944          "  -p: capture screenshot to filename.png (requires -o)\n"
945          "  -z: generate zipped file (requires -o)\n"
946          "  -s: write output to control socket (for init)\n"
947          "  -S: write file location to control socket (for init; requires -o and -z)"
948          "  -q: disable vibrate\n"
949          "  -B: send broadcast when finished (requires -o)\n"
950          "  -P: send broadcast when started and update system properties on "
951          "progress (requires -o and -B)\n"
952          "  -R: take bugreport in remote mode (requires -o, -z, -d and -B, "
953          "shouldn't be used with -P)\n"
954          "  -V: sets the bugreport format version (valid values: %s)\n",
955          VERSION_DEFAULT.c_str());
956}
957
958static void sigpipe_handler(int n) {
959    // don't complain to stderr or stdout
960    _exit(EXIT_FAILURE);
961}
962
963/* adds the temporary report to the existing .zip file, closes the .zip file, and removes the
964   temporary file.
965 */
966static bool finish_zip_file(const std::string& bugreport_name, const std::string& bugreport_path,
967        time_t now) {
968    if (!add_zip_entry(bugreport_name, bugreport_path)) {
969        MYLOGE("Failed to add text entry to .zip file\n");
970        return false;
971    }
972    if (!add_text_zip_entry("main_entry.txt", bugreport_name)) {
973        MYLOGE("Failed to add main_entry.txt to .zip file\n");
974        return false;
975    }
976
977    int32_t err = zip_writer->Finish();
978    if (err) {
979        MYLOGE("zip_writer->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
980        return false;
981    }
982
983    if (is_user_build()) {
984        MYLOGD("Removing temporary file %s\n", bugreport_path.c_str())
985        if (remove(bugreport_path.c_str())) {
986            ALOGW("remove(%s): %s\n", bugreport_path.c_str(), strerror(errno));
987        }
988    } else {
989        MYLOGD("Keeping temporary file %s on non-user build\n", bugreport_path.c_str())
990    }
991
992    return true;
993}
994
995static std::string SHA256_file_hash(std::string filepath) {
996    ScopedFd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC
997            | O_NOFOLLOW)));
998    if (fd.get() == -1) {
999        MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
1000        return NULL;
1001    }
1002
1003    SHA256_CTX ctx;
1004    SHA256_init(&ctx);
1005
1006    std::vector<uint8_t> buffer(65536);
1007    while (1) {
1008        ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
1009        if (bytes_read == 0) {
1010            break;
1011        } else if (bytes_read == -1) {
1012            MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
1013            return NULL;
1014        }
1015
1016        SHA256_update(&ctx, buffer.data(), bytes_read);
1017    }
1018
1019    uint8_t hash[SHA256_DIGEST_SIZE];
1020    memcpy(hash, SHA256_final(&ctx), SHA256_DIGEST_SIZE);
1021    char hash_buffer[SHA256_DIGEST_SIZE * 2 + 1];
1022    for(size_t i = 0; i < SHA256_DIGEST_SIZE; i++) {
1023        sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
1024    }
1025    hash_buffer[sizeof(hash_buffer) - 1] = 0;
1026    return std::string(hash_buffer);
1027}
1028
1029int main(int argc, char *argv[]) {
1030    struct sigaction sigact;
1031    int do_add_date = 0;
1032    int do_zip_file = 0;
1033    int do_vibrate = 1;
1034    char* use_outfile = 0;
1035    int use_socket = 0;
1036    int use_control_socket = 0;
1037    int do_fb = 0;
1038    int do_broadcast = 0;
1039    int do_early_screenshot = 0;
1040    int is_remote_mode = 0;
1041    std::string version = VERSION_DEFAULT;
1042
1043    now = time(NULL);
1044
1045    MYLOGI("begin\n");
1046
1047    /* gets the sequential id */
1048    char last_id[PROPERTY_VALUE_MAX];
1049    property_get("dumpstate.last_id", last_id, "0");
1050    id = strtoul(last_id, NULL, 10) + 1;
1051    snprintf(last_id, sizeof(last_id), "%lu", id);
1052    property_set("dumpstate.last_id", last_id);
1053    MYLOGI("dumpstate id: %lu\n", id);
1054
1055    /* clear SIGPIPE handler */
1056    memset(&sigact, 0, sizeof(sigact));
1057    sigact.sa_handler = sigpipe_handler;
1058    sigaction(SIGPIPE, &sigact, NULL);
1059
1060    /* set as high priority, and protect from OOM killer */
1061    setpriority(PRIO_PROCESS, 0, -20);
1062    FILE *oom_adj = fopen("/proc/self/oom_adj", "we");
1063    if (oom_adj) {
1064        fputs("-17", oom_adj);
1065        fclose(oom_adj);
1066    }
1067
1068    /* parse arguments */
1069    std::string args;
1070    format_args(argc, const_cast<const char **>(argv), &args);
1071    MYLOGD("Dumpstate command line: %s\n", args.c_str());
1072    int c;
1073    while ((c = getopt(argc, argv, "dho:svqzpPBRSV:")) != -1) {
1074        switch (c) {
1075            case 'd': do_add_date = 1;          break;
1076            case 'z': do_zip_file = 1;          break;
1077            case 'o': use_outfile = optarg;     break;
1078            case 's': use_socket = 1;           break;
1079            case 'S': use_control_socket = 1;   break;
1080            case 'v': break;  // compatibility no-op
1081            case 'q': do_vibrate = 0;           break;
1082            case 'p': do_fb = 1;                break;
1083            case 'P': do_update_progress = 1;   break;
1084            case 'R': is_remote_mode = 1;       break;
1085            case 'B': do_broadcast = 1;         break;
1086            case 'V': version = optarg;         break;
1087            case '?': printf("\n");
1088            case 'h':
1089                usage();
1090                exit(1);
1091        }
1092    }
1093
1094    if ((do_zip_file || do_add_date || do_update_progress || do_broadcast) && !use_outfile) {
1095        usage();
1096        exit(1);
1097    }
1098
1099    if (use_control_socket && !do_zip_file) {
1100        usage();
1101        exit(1);
1102    }
1103
1104    if (do_update_progress && !do_broadcast) {
1105        usage();
1106        exit(1);
1107    }
1108
1109    if (is_remote_mode && (do_update_progress || !do_broadcast || !do_zip_file || !do_add_date)) {
1110        usage();
1111        exit(1);
1112    }
1113
1114    if (version != VERSION_DEFAULT) {
1115      usage();
1116      exit(1);
1117    }
1118
1119    MYLOGI("bugreport format version: %s\n", version.c_str());
1120
1121    do_early_screenshot = do_update_progress;
1122
1123    // If we are going to use a socket, do it as early as possible
1124    // to avoid timeouts from bugreport.
1125    if (use_socket) {
1126        redirect_to_socket(stdout, "dumpstate");
1127    }
1128
1129    if (use_control_socket) {
1130        MYLOGD("Opening control socket\n");
1131        control_socket_fd = open_socket("dumpstate");
1132    }
1133
1134    /* full path of the temporary file containing the bugreport */
1135    std::string tmp_path;
1136
1137    /* full path of the file containing the dumpstate logs*/
1138    std::string log_path;
1139
1140    /* full path of the systrace file, when enabled */
1141    std::string systrace_path;
1142
1143    /* full path of the temporary file containing the screenshot (when requested) */
1144    std::string screenshot_path;
1145
1146    /* base name (without suffix or extensions) of the bugreport files */
1147    std::string base_name;
1148
1149    /* pointer to the actual path, be it zip or text */
1150    std::string path;
1151
1152    /* pointer to the zipped file */
1153    std::unique_ptr<FILE, int(*)(FILE*)> zip_file(NULL, fclose);
1154
1155    /* redirect output if needed */
1156    bool is_redirecting = !use_socket && use_outfile;
1157
1158    if (is_redirecting) {
1159        bugreport_dir = dirname(use_outfile);
1160        base_name = basename(use_outfile);
1161        if (do_add_date) {
1162            char date[80];
1163            strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&now));
1164            suffix = date;
1165        } else {
1166            suffix = "undated";
1167        }
1168        char build_id[PROPERTY_VALUE_MAX];
1169        property_get("ro.build.id", build_id, "UNKNOWN_BUILD");
1170        base_name = base_name + "-" + build_id;
1171        if (do_fb) {
1172            // TODO: if dumpstate was an object, the paths could be internal variables and then
1173            // we could have a function to calculate the derived values, such as:
1174            //     screenshot_path = GetPath(".png");
1175            screenshot_path = bugreport_dir + "/" + base_name + "-" + suffix + ".png";
1176        }
1177        tmp_path = bugreport_dir + "/" + base_name + "-" + suffix + ".tmp";
1178        log_path = bugreport_dir + "/dumpstate_log-" + suffix + "-"
1179                + std::to_string(getpid()) + ".txt";
1180
1181        MYLOGD("Bugreport dir: %s\n"
1182                "Base name: %s\n"
1183                "Suffix: %s\n"
1184                "Log path: %s\n"
1185                "Temporary path: %s\n"
1186                "Screenshot path: %s\n",
1187                bugreport_dir.c_str(), base_name.c_str(), suffix.c_str(),
1188                log_path.c_str(), tmp_path.c_str(), screenshot_path.c_str());
1189
1190        if (do_zip_file) {
1191            path = bugreport_dir + "/" + base_name + "-" + suffix + ".zip";
1192            MYLOGD("Creating initial .zip file (%s)\n", path.c_str());
1193            create_parent_dirs(path.c_str());
1194            zip_file.reset(fopen(path.c_str(), "wb"));
1195            if (!zip_file) {
1196                MYLOGE("fopen(%s, 'wb'): %s\n", path.c_str(), strerror(errno));
1197                do_zip_file = 0;
1198            } else {
1199                zip_writer.reset(new ZipWriter(zip_file.get()));
1200            }
1201            add_text_zip_entry("version.txt", version);
1202        }
1203
1204        if (do_update_progress) {
1205            std::vector<std::string> am_args = {
1206                 "--receiver-permission", "android.permission.DUMP", "--receiver-foreground",
1207                 "--es", "android.intent.extra.NAME", suffix,
1208                 "--ei", "android.intent.extra.ID", std::to_string(id),
1209                 "--ei", "android.intent.extra.PID", std::to_string(getpid()),
1210                 "--ei", "android.intent.extra.MAX", std::to_string(WEIGHT_TOTAL),
1211            };
1212            send_broadcast("android.intent.action.BUGREPORT_STARTED", am_args);
1213        }
1214    }
1215
1216    /* read /proc/cmdline before dropping root */
1217    FILE *cmdline = fopen("/proc/cmdline", "re");
1218    if (cmdline) {
1219        fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
1220        fclose(cmdline);
1221    }
1222
1223    /* open the vibrator before dropping root */
1224    std::unique_ptr<FILE, int(*)(FILE*)> vibrator(NULL, fclose);
1225    if (do_vibrate) {
1226        vibrator.reset(fopen("/sys/class/timed_output/vibrator/enable", "we"));
1227        if (vibrator) {
1228            vibrate(vibrator.get(), 150);
1229        }
1230    }
1231
1232    if (do_fb && do_early_screenshot) {
1233        if (screenshot_path.empty()) {
1234            // should not have happened
1235            MYLOGE("INTERNAL ERROR: skipping early screenshot because path was not set\n");
1236        } else {
1237            MYLOGI("taking early screenshot\n");
1238            take_screenshot(screenshot_path);
1239            MYLOGI("wrote screenshot: %s\n", screenshot_path.c_str());
1240            if (chown(screenshot_path.c_str(), AID_SHELL, AID_SHELL)) {
1241                MYLOGE("Unable to change ownership of screenshot file %s: %s\n",
1242                        screenshot_path.c_str(), strerror(errno));
1243            }
1244        }
1245    }
1246
1247    if (do_zip_file) {
1248        if (chown(path.c_str(), AID_SHELL, AID_SHELL)) {
1249            MYLOGE("Unable to change ownership of zip file %s: %s\n", path.c_str(), strerror(errno));
1250        }
1251    }
1252
1253    if (is_redirecting) {
1254        redirect_to_file(stderr, const_cast<char*>(log_path.c_str()));
1255        if (chown(log_path.c_str(), AID_SHELL, AID_SHELL)) {
1256            MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n",
1257                    log_path.c_str(), strerror(errno));
1258        }
1259        /* TODO: rather than generating a text file now and zipping it later,
1260           it would be more efficient to redirect stdout to the zip entry
1261           directly, but the libziparchive doesn't support that option yet. */
1262        redirect_to_file(stdout, const_cast<char*>(tmp_path.c_str()));
1263        if (chown(tmp_path.c_str(), AID_SHELL, AID_SHELL)) {
1264            MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
1265                    tmp_path.c_str(), strerror(errno));
1266        }
1267    }
1268    // NOTE: there should be no stdout output until now, otherwise it would break the header.
1269    // In particular, DurationReport objects should be created passing 'title, NULL', so their
1270    // duration is logged into MYLOG instead.
1271    print_header(version);
1272
1273    // Dumps systrace right away, otherwise it will be filled with unnecessary events.
1274    dump_systrace();
1275
1276    // Invoking the following dumpsys calls before dump_traces() to try and
1277    // keep the system stats as close to its initial state as possible.
1278    run_command_as_shell("DUMPSYS MEMINFO", 30, "dumpsys", "-t", "30", "meminfo", "-a", NULL);
1279    run_command_as_shell("DUMPSYS CPUINFO", 10, "dumpsys", "-t", "10", "cpuinfo", "-a", NULL);
1280
1281    /* collect stack traces from Dalvik and native processes (needs root) */
1282    dump_traces_path = dump_traces();
1283
1284    /* Get the tombstone fds, recovery files, and mount info here while we are running as root. */
1285    get_tombstone_fds(tombstone_data);
1286    add_dir(RECOVERY_DIR, true);
1287    add_dir(RECOVERY_DATA_DIR, true);
1288    add_dir(LOGPERSIST_DATA_DIR, false);
1289    add_mountinfo();
1290
1291    if (!drop_root_user()) {
1292        return -1;
1293    }
1294
1295    dumpstate(do_early_screenshot ? "": screenshot_path, version);
1296
1297    /* close output if needed */
1298    if (is_redirecting) {
1299        fclose(stdout);
1300    }
1301
1302    /* rename or zip the (now complete) .tmp file to its final location */
1303    if (use_outfile) {
1304
1305        /* check if user changed the suffix using system properties */
1306        char key[PROPERTY_KEY_MAX];
1307        char value[PROPERTY_VALUE_MAX];
1308        snprintf(key, sizeof(key), "dumpstate.%d.name", getpid());
1309        property_get(key, value, "");
1310        bool change_suffix= false;
1311        if (value[0]) {
1312            /* must whitelist which characters are allowed, otherwise it could cross directories */
1313            std::regex valid_regex("^[-_a-zA-Z0-9]+$");
1314            if (std::regex_match(value, valid_regex)) {
1315                change_suffix = true;
1316            } else {
1317                MYLOGE("invalid suffix provided by user: %s\n", value);
1318            }
1319        }
1320        if (change_suffix) {
1321            MYLOGI("changing suffix from %s to %s\n", suffix.c_str(), value);
1322            suffix = value;
1323            if (!screenshot_path.empty()) {
1324                std::string new_screenshot_path =
1325                        bugreport_dir + "/" + base_name + "-" + suffix + ".png";
1326                if (rename(screenshot_path.c_str(), new_screenshot_path.c_str())) {
1327                    MYLOGE("rename(%s, %s): %s\n", screenshot_path.c_str(),
1328                            new_screenshot_path.c_str(), strerror(errno));
1329                } else {
1330                    screenshot_path = new_screenshot_path;
1331                }
1332            }
1333        }
1334
1335        bool do_text_file = true;
1336        if (do_zip_file) {
1337            std::string entry_name = base_name + "-" + suffix + ".txt";
1338            MYLOGD("Adding main entry (%s) to .zip bugreport\n", entry_name.c_str());
1339            if (!finish_zip_file(entry_name, tmp_path, now)) {
1340                MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
1341                do_text_file = true;
1342            } else {
1343                do_text_file = false;
1344                // Since zip file is already created, it needs to be renamed.
1345                std::string new_path = bugreport_dir + "/" + base_name + "-" + suffix + ".zip";
1346                if (path != new_path) {
1347                    MYLOGD("Renaming zip file from %s to %s\n", path.c_str(), new_path.c_str());
1348                    if (rename(path.c_str(), new_path.c_str())) {
1349                        MYLOGE("rename(%s, %s): %s\n", path.c_str(),
1350                                new_path.c_str(), strerror(errno));
1351                    } else {
1352                        path = new_path;
1353                    }
1354                }
1355            }
1356        }
1357        if (do_text_file) {
1358            path = bugreport_dir + "/" + base_name + "-" + suffix + ".txt";
1359            MYLOGD("Generating .txt bugreport at %s from %s\n", path.c_str(), tmp_path.c_str());
1360            if (rename(tmp_path.c_str(), path.c_str())) {
1361                MYLOGE("rename(%s, %s): %s\n", tmp_path.c_str(), path.c_str(), strerror(errno));
1362                path.clear();
1363            }
1364        }
1365        if (use_control_socket) {
1366            if (do_text_file) {
1367                dprintf(control_socket_fd, "FAIL:could not create zip file, check %s "
1368                        "for more details\n", log_path.c_str());
1369            } else {
1370                dprintf(control_socket_fd, "OK:%s\n", path.c_str());
1371            }
1372        }
1373    }
1374
1375    /* vibrate a few but shortly times to let user know it's finished */
1376    if (vibrator) {
1377        for (int i = 0; i < 3; i++) {
1378            vibrate(vibrator.get(), 75);
1379            usleep((75 + 50) * 1000);
1380        }
1381    }
1382
1383    /* tell activity manager we're done */
1384    if (do_broadcast) {
1385        if (!path.empty()) {
1386            MYLOGI("Final bugreport path: %s\n", path.c_str());
1387            std::vector<std::string> am_args = {
1388                 "--receiver-permission", "android.permission.DUMP", "--receiver-foreground",
1389                 "--ei", "android.intent.extra.ID", std::to_string(id),
1390                 "--ei", "android.intent.extra.PID", std::to_string(getpid()),
1391                 "--ei", "android.intent.extra.MAX", std::to_string(weight_total),
1392                 "--es", "android.intent.extra.BUGREPORT", path,
1393                 "--es", "android.intent.extra.DUMPSTATE_LOG", log_path
1394            };
1395            if (do_fb) {
1396                am_args.push_back("--es");
1397                am_args.push_back("android.intent.extra.SCREENSHOT");
1398                am_args.push_back(screenshot_path);
1399            }
1400            if (is_remote_mode) {
1401                am_args.push_back("--es");
1402                am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
1403                am_args.push_back(SHA256_file_hash(path));
1404                send_broadcast("android.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
1405            } else {
1406                send_broadcast("android.intent.action.BUGREPORT_FINISHED", am_args);
1407            }
1408        } else {
1409            MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
1410        }
1411    }
1412
1413    MYLOGD("Final progress: %d/%d (originally %d)\n", progress, weight_total, WEIGHT_TOTAL);
1414    MYLOGI("done\n");
1415
1416    if (is_redirecting) {
1417        fclose(stderr);
1418    }
1419
1420    if (use_control_socket && control_socket_fd >= 0) {
1421        MYLOGD("Closing control socket\n");
1422        close(control_socket_fd);
1423    }
1424
1425    return 0;
1426}
1427