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