dumpstate.cpp revision 71bbfc57974331dce79242ce806d92035fce06ba 
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 <limits.h>
21#include <memory>
22#include <stdbool.h>
23#include <stdio.h>
24#include <stdlib.h>
25#include <string>
26#include <string.h>
27#include <sys/capability.h>
28#include <sys/prctl.h>
29#include <sys/resource.h>
30#include <sys/stat.h>
31#include <sys/time.h>
32#include <sys/wait.h>
33#include <unistd.h>
34
35#include <base/stringprintf.h>
36#include <cutils/properties.h>
37
38#include "private/android_filesystem_config.h"
39
40#define LOG_TAG "dumpstate"
41#include <cutils/log.h>
42
43#include "dumpstate.h"
44#include "ScopedFd.h"
45#include "ziparchive/zip_writer.h"
46
47using android::base::StringPrintf;
48
49/* read before root is shed */
50static char cmdline_buf[16384] = "(unknown)";
51static const char *dump_traces_path = NULL;
52
53static std::string screenshot_path;
54
55#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
56
57#define RAFT_DIR "/data/misc/raft/"
58#define TOMBSTONE_DIR "/data/tombstones"
59#define TOMBSTONE_FILE_PREFIX TOMBSTONE_DIR "/tombstone_"
60/* Can accomodate a tombstone number up to 9999. */
61#define TOMBSTONE_MAX_LEN (sizeof(TOMBSTONE_FILE_PREFIX) + 4)
62#define NUM_TOMBSTONES  10
63
64typedef struct {
65  char name[TOMBSTONE_MAX_LEN];
66  int fd;
67} tombstone_data_t;
68
69static tombstone_data_t tombstone_data[NUM_TOMBSTONES];
70
71/* Get the fds of any tombstone that was modified in the last half an hour. */
72static void get_tombstone_fds(tombstone_data_t data[NUM_TOMBSTONES]) {
73    time_t thirty_minutes_ago = time(NULL) - 60*30;
74    for (size_t i = 0; i < NUM_TOMBSTONES; i++) {
75        snprintf(data[i].name, sizeof(data[i].name), "%s%02zu", TOMBSTONE_FILE_PREFIX, i);
76        int fd = TEMP_FAILURE_RETRY(open(data[i].name,
77                                         O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK));
78        struct stat st;
79        if (fstat(fd, &st) == 0 && S_ISREG(st.st_mode) &&
80                (time_t) st.st_mtime >= thirty_minutes_ago) {
81            data[i].fd = fd;
82        } else {
83            close(fd);
84            data[i].fd = -1;
85        }
86    }
87}
88
89static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
90{
91    DIR *d;
92    struct dirent *de;
93    char path[PATH_MAX];
94
95    d = opendir(driverpath);
96    if (d == NULL) {
97        return;
98    }
99
100    while ((de = readdir(d))) {
101        if (de->d_type != DT_LNK) {
102            continue;
103        }
104        snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
105        dump_file(title, path);
106    }
107
108    closedir(d);
109}
110
111static bool skip_not_stat(const char *path) {
112    static const char stat[] = "/stat";
113    size_t len = strlen(path);
114    if (path[len - 1] == '/') { /* Directory? */
115        return false;
116    }
117    return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
118}
119
120static const char mmcblk0[] = "/sys/block/mmcblk0/";
121unsigned long worst_write_perf = 20000; /* in KB/s */
122
123static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
124    unsigned long fields[11], read_perf, write_perf;
125    bool z;
126    char *cp, *buffer = NULL;
127    size_t i = 0;
128    FILE *fp = fdopen(fd, "rb");
129    getline(&buffer, &i, fp);
130    fclose(fp);
131    if (!buffer) {
132        return -errno;
133    }
134    i = strlen(buffer);
135    while ((i > 0) && (buffer[i - 1] == '\n')) {
136        buffer[--i] = '\0';
137    }
138    if (!*buffer) {
139        free(buffer);
140        return 0;
141    }
142    z = true;
143    for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
144        fields[i] = strtol(cp, &cp, 0);
145        if (fields[i] != 0) {
146            z = false;
147        }
148    }
149    if (z) { /* never accessed */
150        free(buffer);
151        return 0;
152    }
153
154    if (!strncmp(path, mmcblk0, sizeof(mmcblk0) - 1)) {
155        path += sizeof(mmcblk0) - 1;
156    }
157
158    printf("%s: %s\n", path, buffer);
159    free(buffer);
160
161    read_perf = 0;
162    if (fields[3]) {
163        read_perf = 512 * fields[2] / fields[3];
164    }
165    write_perf = 0;
166    if (fields[7]) {
167        write_perf = 512 * fields[6] / fields[7];
168    }
169    printf("%s: read: %luKB/s write: %luKB/s\n", path, read_perf, write_perf);
170    if ((write_perf > 1) && (write_perf < worst_write_perf)) {
171        worst_write_perf = write_perf;
172    }
173    return 0;
174}
175
176/* Copied policy from system/core/logd/LogBuffer.cpp */
177
178#define LOG_BUFFER_SIZE (256 * 1024)
179#define LOG_BUFFER_MIN_SIZE (64 * 1024UL)
180#define LOG_BUFFER_MAX_SIZE (256 * 1024 * 1024UL)
181
182static bool valid_size(unsigned long value) {
183    if ((value < LOG_BUFFER_MIN_SIZE) || (LOG_BUFFER_MAX_SIZE < value)) {
184        return false;
185    }
186
187    long pages = sysconf(_SC_PHYS_PAGES);
188    if (pages < 1) {
189        return true;
190    }
191
192    long pagesize = sysconf(_SC_PAGESIZE);
193    if (pagesize <= 1) {
194        pagesize = PAGE_SIZE;
195    }
196
197    // maximum memory impact a somewhat arbitrary ~3%
198    pages = (pages + 31) / 32;
199    unsigned long maximum = pages * pagesize;
200
201    if ((maximum < LOG_BUFFER_MIN_SIZE) || (LOG_BUFFER_MAX_SIZE < maximum)) {
202        return true;
203    }
204
205    return value <= maximum;
206}
207
208static unsigned long property_get_size(const char *key) {
209    unsigned long value;
210    char *cp, property[PROPERTY_VALUE_MAX];
211
212    property_get(key, property, "");
213    value = strtoul(property, &cp, 10);
214
215    switch(*cp) {
216    case 'm':
217    case 'M':
218        value *= 1024;
219    /* FALLTHRU */
220    case 'k':
221    case 'K':
222        value *= 1024;
223    /* FALLTHRU */
224    case '\0':
225        break;
226
227    default:
228        value = 0;
229    }
230
231    if (!valid_size(value)) {
232        value = 0;
233    }
234
235    return value;
236}
237
238/* timeout in ms */
239static unsigned long logcat_timeout(const char *name) {
240    static const char global_tuneable[] = "persist.logd.size"; // Settings App
241    static const char global_default[] = "ro.logd.size";       // BoardConfig.mk
242    char key[PROP_NAME_MAX];
243    unsigned long property_size, default_size;
244
245    default_size = property_get_size(global_tuneable);
246    if (!default_size) {
247        default_size = property_get_size(global_default);
248    }
249
250    snprintf(key, sizeof(key), "%s.%s", global_tuneable, name);
251    property_size = property_get_size(key);
252
253    if (!property_size) {
254        snprintf(key, sizeof(key), "%s.%s", global_default, name);
255        property_size = property_get_size(key);
256    }
257
258    if (!property_size) {
259        property_size = default_size;
260    }
261
262    if (!property_size) {
263        property_size = LOG_BUFFER_SIZE;
264    }
265
266    /* Engineering margin is ten-fold our guess */
267    return 10 * (property_size + worst_write_perf) / worst_write_perf;
268}
269
270/* End copy from system/core/logd/LogBuffer.cpp */
271
272/* dumps the current system state to stdout */
273static void dumpstate() {
274    unsigned long timeout;
275    time_t now = time(NULL);
276    char build[PROPERTY_VALUE_MAX], fingerprint[PROPERTY_VALUE_MAX];
277    char radio[PROPERTY_VALUE_MAX], bootloader[PROPERTY_VALUE_MAX];
278    char network[PROPERTY_VALUE_MAX], date[80];
279    char build_type[PROPERTY_VALUE_MAX];
280
281    property_get("ro.build.display.id", build, "(unknown)");
282    property_get("ro.build.fingerprint", fingerprint, "(unknown)");
283    property_get("ro.build.type", build_type, "(unknown)");
284    property_get("ro.baseband", radio, "(unknown)");
285    property_get("ro.bootloader", bootloader, "(unknown)");
286    property_get("gsm.operator.alpha", network, "(unknown)");
287    strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now));
288
289    printf("========================================================\n");
290    printf("== dumpstate: %s\n", date);
291    printf("========================================================\n");
292
293    printf("\n");
294    printf("Build: %s\n", build);
295    printf("Build fingerprint: '%s'\n", fingerprint); /* format is important for other tools */
296    printf("Bootloader: %s\n", bootloader);
297    printf("Radio: %s\n", radio);
298    printf("Network: %s\n", network);
299
300    printf("Kernel: ");
301    dump_file(NULL, "/proc/version");
302    printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
303    printf("\n");
304
305    dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
306    run_command("UPTIME", 10, "uptime", NULL);
307    dump_files("UPTIME MMC PERF", mmcblk0, skip_not_stat, dump_stat_from_fd);
308    dump_file("MEMORY INFO", "/proc/meminfo");
309    run_command("CPU INFO", 10, "top", "-n", "1", "-d", "1", "-m", "30", "-H", NULL);
310    run_command("PROCRANK", 20, SU_PATH, "root", "procrank", NULL);
311    dump_file("VIRTUAL MEMORY STATS", "/proc/vmstat");
312    dump_file("VMALLOC INFO", "/proc/vmallocinfo");
313    dump_file("SLAB INFO", "/proc/slabinfo");
314    dump_file("ZONEINFO", "/proc/zoneinfo");
315    dump_file("PAGETYPEINFO", "/proc/pagetypeinfo");
316    dump_file("BUDDYINFO", "/proc/buddyinfo");
317    dump_file("FRAGMENTATION INFO", "/d/extfrag/unusable_index");
318
319    dump_file("KERNEL WAKELOCKS", "/proc/wakelocks");
320    dump_file("KERNEL WAKE SOURCES", "/d/wakeup_sources");
321    dump_file("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
322    dump_file("KERNEL SYNC", "/d/sync");
323
324    run_command("PROCESSES AND THREADS", 10, "ps", "-Z", "-t", "-p", "-P", NULL);
325    run_command("LIBRANK", 10, "librank", NULL);
326
327    do_dmesg();
328
329    run_command("LIST OF OPEN FILES", 10, SU_PATH, "root", "lsof", NULL);
330    for_each_pid(do_showmap, "SMAPS OF ALL PROCESSES");
331    for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
332
333    if (!screenshot_path.empty()) {
334        ALOGI("taking screenshot\n");
335        const char *args[] = { "/system/bin/screencap", "-p", screenshot_path.c_str(), NULL };
336        run_command_always(NULL, 10, args);
337        ALOGI("wrote screenshot: %s\n", screenshot_path.c_str());
338    }
339
340    // dump_file("EVENT LOG TAGS", "/etc/event-log-tags");
341    // calculate timeout
342    timeout = logcat_timeout("main") + logcat_timeout("system") + logcat_timeout("crash");
343    if (timeout < 20000) {
344        timeout = 20000;
345    }
346    run_command("SYSTEM LOG", timeout / 1000, "logcat", "-v", "threadtime",
347                                                        "-v", "printable",
348                                                        "-d",
349                                                        "*:v", NULL);
350    timeout = logcat_timeout("events");
351    if (timeout < 20000) {
352        timeout = 20000;
353    }
354    run_command("EVENT LOG", timeout / 1000, "logcat", "-b", "events",
355                                                       "-v", "threadtime",
356                                                       "-v", "printable",
357                                                       "-d",
358                                                       "*:v", NULL);
359    timeout = logcat_timeout("radio");
360    if (timeout < 20000) {
361        timeout = 20000;
362    }
363    run_command("RADIO LOG", timeout / 1000, "logcat", "-b", "radio",
364                                                       "-v", "threadtime",
365                                                       "-v", "printable",
366                                                       "-d",
367                                                       "*:v", NULL);
368
369    run_command("LOG STATISTICS", 10, "logcat", "-b", "all", "-S", NULL);
370
371    run_command("RAFT LOGS", 300, SU_PATH, "root", "logcompressor", "-r", RAFT_DIR, NULL);
372
373    /* show the traces we collected in main(), if that was done */
374    if (dump_traces_path != NULL) {
375        dump_file("VM TRACES JUST NOW", dump_traces_path);
376    }
377
378    /* only show ANR traces if they're less than 15 minutes old */
379    struct stat st;
380    char anr_traces_path[PATH_MAX];
381    property_get("dalvik.vm.stack-trace-file", anr_traces_path, "");
382    if (!anr_traces_path[0]) {
383        printf("*** NO VM TRACES FILE DEFINED (dalvik.vm.stack-trace-file)\n\n");
384    } else {
385      int fd = TEMP_FAILURE_RETRY(open(anr_traces_path,
386                                       O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK));
387      if (fd < 0) {
388          printf("*** NO ANR VM TRACES FILE (%s): %s\n\n", anr_traces_path, strerror(errno));
389      } else {
390          dump_file_from_fd("VM TRACES AT LAST ANR", anr_traces_path, fd);
391      }
392    }
393
394    /* slow traces for slow operations */
395    if (anr_traces_path[0] != 0) {
396        int tail = strlen(anr_traces_path)-1;
397        while (tail > 0 && anr_traces_path[tail] != '/') {
398            tail--;
399        }
400        int i = 0;
401        while (1) {
402            sprintf(anr_traces_path+tail+1, "slow%02d.txt", i);
403            if (stat(anr_traces_path, &st)) {
404                // No traces file at this index, done with the files.
405                break;
406            }
407            dump_file("VM TRACES WHEN SLOW", anr_traces_path);
408            i++;
409        }
410    }
411
412    int dumped = 0;
413    for (size_t i = 0; i < NUM_TOMBSTONES; i++) {
414        if (tombstone_data[i].fd != -1) {
415            dumped = 1;
416            dump_file_from_fd("TOMBSTONE", tombstone_data[i].name, tombstone_data[i].fd);
417            tombstone_data[i].fd = -1;
418        }
419    }
420    if (!dumped) {
421        printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR);
422    }
423
424    dump_file("NETWORK DEV INFO", "/proc/net/dev");
425    dump_file("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
426    dump_file("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
427    dump_file("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
428    dump_file("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
429
430    if (!stat(PSTORE_LAST_KMSG, &st)) {
431        /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
432        dump_file("LAST KMSG", PSTORE_LAST_KMSG);
433    } else {
434        /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
435        dump_file("LAST KMSG", "/proc/last_kmsg");
436    }
437
438    /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
439    run_command("LAST LOGCAT", 10, "logcat", "-L",
440                                             "-b", "all",
441                                             "-v", "threadtime",
442                                             "-v", "printable",
443                                             "-d",
444                                             "*:v", NULL);
445
446    /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
447
448    run_command("NETWORK INTERFACES", 10, "ip", "link", NULL);
449
450    run_command("IPv4 ADDRESSES", 10, "ip", "-4", "addr", "show", NULL);
451    run_command("IPv6 ADDRESSES", 10, "ip", "-6", "addr", "show", NULL);
452
453    run_command("IP RULES", 10, "ip", "rule", "show", NULL);
454    run_command("IP RULES v6", 10, "ip", "-6", "rule", "show", NULL);
455
456    dump_route_tables();
457
458    run_command("ARP CACHE", 10, "ip", "-4", "neigh", "show", NULL);
459    run_command("IPv6 ND CACHE", 10, "ip", "-6", "neigh", "show", NULL);
460
461    run_command("IPTABLES", 10, SU_PATH, "root", "iptables", "-L", "-nvx", NULL);
462    run_command("IP6TABLES", 10, SU_PATH, "root", "ip6tables", "-L", "-nvx", NULL);
463    run_command("IPTABLE NAT", 10, SU_PATH, "root", "iptables", "-t", "nat", "-L", "-nvx", NULL);
464    /* no ip6 nat */
465    run_command("IPTABLE RAW", 10, SU_PATH, "root", "iptables", "-t", "raw", "-L", "-nvx", NULL);
466    run_command("IP6TABLE RAW", 10, SU_PATH, "root", "ip6tables", "-t", "raw", "-L", "-nvx", NULL);
467
468    run_command("WIFI NETWORKS", 20,
469            SU_PATH, "root", "wpa_cli", "IFNAME=wlan0", "list_networks", NULL);
470
471#ifdef FWDUMP_bcmdhd
472    run_command("ND OFFLOAD TABLE", 5,
473            SU_PATH, "root", "wlutil", "nd_hostip", NULL);
474
475    run_command("DUMP WIFI INTERNAL COUNTERS (1)", 20,
476            SU_PATH, "root", "wlutil", "counters", NULL);
477
478    run_command("ND OFFLOAD STATUS (1)", 5,
479            SU_PATH, "root", "wlutil", "nd_status", NULL);
480
481#endif
482    dump_file("INTERRUPTS (1)", "/proc/interrupts");
483
484    run_command("NETWORK DIAGNOSTICS", 10, "dumpsys", "connectivity", "--diag", NULL);
485
486#ifdef FWDUMP_bcmdhd
487    run_command("DUMP WIFI STATUS", 20,
488            SU_PATH, "root", "dhdutil", "-i", "wlan0", "dump", NULL);
489
490    run_command("DUMP WIFI INTERNAL COUNTERS (2)", 20,
491            SU_PATH, "root", "wlutil", "counters", NULL);
492
493    run_command("ND OFFLOAD STATUS (2)", 5,
494            SU_PATH, "root", "wlutil", "nd_status", NULL);
495#endif
496    dump_file("INTERRUPTS (2)", "/proc/interrupts");
497
498    print_properties();
499
500    run_command("VOLD DUMP", 10, "vdc", "dump", NULL);
501    run_command("SECURE CONTAINERS", 10, "vdc", "asec", "list", NULL);
502
503    run_command("FILESYSTEMS & FREE SPACE", 10, "df", NULL);
504
505    run_command("LAST RADIO LOG", 10, "parse_radio_log", "/proc/last_radio_log", NULL);
506
507    printf("------ BACKLIGHTS ------\n");
508    printf("LCD brightness=");
509    dump_file(NULL, "/sys/class/leds/lcd-backlight/brightness");
510    printf("Button brightness=");
511    dump_file(NULL, "/sys/class/leds/button-backlight/brightness");
512    printf("Keyboard brightness=");
513    dump_file(NULL, "/sys/class/leds/keyboard-backlight/brightness");
514    printf("ALS mode=");
515    dump_file(NULL, "/sys/class/leds/lcd-backlight/als");
516    printf("LCD driver registers:\n");
517    dump_file(NULL, "/sys/class/leds/lcd-backlight/registers");
518    printf("\n");
519
520    /* Binder state is expensive to look at as it uses a lot of memory. */
521    dump_file("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
522    dump_file("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
523    dump_file("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
524    dump_file("BINDER STATS", "/sys/kernel/debug/binder/stats");
525    dump_file("BINDER STATE", "/sys/kernel/debug/binder/state");
526
527    printf("========================================================\n");
528    printf("== Board\n");
529    printf("========================================================\n");
530
531    dumpstate_board();
532    printf("\n");
533
534    /* Migrate the ril_dumpstate to a dumpstate_board()? */
535    char ril_dumpstate_timeout[PROPERTY_VALUE_MAX] = {0};
536    property_get("ril.dumpstate.timeout", ril_dumpstate_timeout, "30");
537    if (strnlen(ril_dumpstate_timeout, PROPERTY_VALUE_MAX - 1) > 0) {
538        if (0 == strncmp(build_type, "user", PROPERTY_VALUE_MAX - 1)) {
539            // su does not exist on user builds, so try running without it.
540            // This way any implementations of vril-dump that do not require
541            // root can run on user builds.
542            run_command("DUMP VENDOR RIL LOGS", atoi(ril_dumpstate_timeout),
543                    "vril-dump", NULL);
544        } else {
545            run_command("DUMP VENDOR RIL LOGS", atoi(ril_dumpstate_timeout),
546                    SU_PATH, "root", "vril-dump", NULL);
547        }
548    }
549
550    printf("========================================================\n");
551    printf("== Android Framework Services\n");
552    printf("========================================================\n");
553
554    /* the full dumpsys is starting to take a long time, so we need
555       to increase its timeout.  we really need to do the timeouts in
556       dumpsys itself... */
557    run_command("DUMPSYS", 60, "dumpsys", NULL);
558
559    printf("========================================================\n");
560    printf("== Checkins\n");
561    printf("========================================================\n");
562
563    run_command("CHECKIN BATTERYSTATS", 30, "dumpsys", "batterystats", "-c", NULL);
564    run_command("CHECKIN MEMINFO", 30, "dumpsys", "meminfo", "--checkin", NULL);
565    run_command("CHECKIN NETSTATS", 30, "dumpsys", "netstats", "--checkin", NULL);
566    run_command("CHECKIN PROCSTATS", 30, "dumpsys", "procstats", "-c", NULL);
567    run_command("CHECKIN USAGESTATS", 30, "dumpsys", "usagestats", "-c", NULL);
568    run_command("CHECKIN PACKAGE", 30, "dumpsys", "package", "--checkin", NULL);
569
570    printf("========================================================\n");
571    printf("== Running Application Activities\n");
572    printf("========================================================\n");
573
574    run_command("APP ACTIVITIES", 30, "dumpsys", "activity", "all", NULL);
575
576    printf("========================================================\n");
577    printf("== Running Application Services\n");
578    printf("========================================================\n");
579
580    run_command("APP SERVICES", 30, "dumpsys", "activity", "service", "all", NULL);
581
582    printf("========================================================\n");
583    printf("== Running Application Providers\n");
584    printf("========================================================\n");
585
586    run_command("APP SERVICES", 30, "dumpsys", "activity", "provider", "all", NULL);
587
588
589    printf("========================================================\n");
590    printf("== dumpstate: done\n");
591    printf("========================================================\n");
592}
593
594static void usage() {
595    fprintf(stderr, "usage: dumpstate [-b soundfile] [-e soundfile] [-o file [-d] [-p] [-z]] [-s] [-q]\n"
596            "  -o: write to file (instead of stdout)\n"
597            "  -d: append date to filename (requires -o)\n"
598            "  -z: generates zipped file (requires -o)\n"
599            "  -p: capture screenshot to filename.png (requires -o)\n"
600            "  -s: write output to control socket (for init)\n"
601            "  -b: play sound file instead of vibrate, at beginning of job\n"
602            "  -e: play sound file instead of vibrate, at end of job\n"
603            "  -q: disable vibrate\n"
604            "  -B: send broadcast when finished (requires -o)\n"
605            "  -P: send broadacast when started and update system properties on progress (requires -o and -B)\n"
606                );
607}
608
609static void sigpipe_handler(int n) {
610    // don't complain to stderr or stdout
611    _exit(EXIT_FAILURE);
612}
613
614static void vibrate(FILE* vibrator, int ms) {
615    fprintf(vibrator, "%d\n", ms);
616    fflush(vibrator);
617}
618
619/* generates a zipfile on 'path' with an entry with the contents of 'tmp_path'
620   and removes the temporary file.
621 */
622static bool generate_zip_file(std::string tmp_path, std::string path,
623                             std::string entry_name, time_t entry_time) {
624    std::unique_ptr<FILE, int(*)(FILE*)> file(fopen(path.c_str(), "wb"), fclose);
625    if (!file) {
626        ALOGE("fopen(%s, 'wb'): %s\n", path.c_str(), strerror(errno));
627        return false;
628    }
629
630    ZipWriter writer(file.get());
631    int32_t err = writer.StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, entry_time);
632    if (err) {
633        ALOGE("writer.StartEntryWithTime(%s): %s\n", entry_name.c_str(), ZipWriter::ErrorCodeString(err));
634        return false;
635    }
636
637    ScopedFd fd(TEMP_FAILURE_RETRY(open(tmp_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
638    if (fd.get() == -1) {
639        ALOGE("open(%s): %s\n", tmp_path.c_str(), strerror(errno));
640        return false;
641    }
642
643    while (1) {
644        std::vector<uint8_t> buffer(65536);
645        ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), sizeof(buffer)));
646        if (bytes_read == 0) {
647            break;
648        } else if (bytes_read == -1) {
649            ALOGE("read(%s): %s\n", tmp_path.c_str(), strerror(errno));
650            return false;
651       }
652       err = writer.WriteBytes(buffer.data(), bytes_read);
653       if (err) {
654           ALOGE("writer.WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
655           return false;
656       }
657    }
658
659    err = writer.FinishEntry();
660    if (err) {
661        ALOGE("writer.FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
662        return false;
663    }
664
665    err = writer.Finish();
666    if (err) {
667        ALOGE("writer.Finish(): %s\n", ZipWriter::ErrorCodeString(err));
668        return false;
669    }
670
671    if (remove(tmp_path.c_str())) {
672        ALOGE("remove(%s): %s\n", tmp_path.c_str(), strerror(errno));
673        return false;
674    }
675
676    return true;
677}
678
679
680int main(int argc, char *argv[]) {
681    struct sigaction sigact;
682    int do_add_date = 0;
683    int do_zip_file = 0;
684    int do_vibrate = 1;
685    char* use_outfile = 0;
686    int use_socket = 0;
687    int do_fb = 0;
688    int do_broadcast = 0;
689
690    if (getuid() != 0) {
691        // Old versions of the adb client would call the
692        // dumpstate command directly. Newer clients
693        // call /system/bin/bugreport instead. If we detect
694        // we're being called incorrectly, then exec the
695        // correct program.
696        return execl("/system/bin/bugreport", "/system/bin/bugreport", NULL);
697    }
698
699    ALOGI("begin\n");
700
701    /* clear SIGPIPE handler */
702    memset(&sigact, 0, sizeof(sigact));
703    sigact.sa_handler = sigpipe_handler;
704    sigaction(SIGPIPE, &sigact, NULL);
705
706    /* set as high priority, and protect from OOM killer */
707    setpriority(PRIO_PROCESS, 0, -20);
708    FILE *oom_adj = fopen("/proc/self/oom_adj", "we");
709    if (oom_adj) {
710        fputs("-17", oom_adj);
711        fclose(oom_adj);
712    }
713
714    /* parse arguments */
715    int c;
716    while ((c = getopt(argc, argv, "dho:svqzpPB")) != -1) {
717        switch (c) {
718            case 'd': do_add_date = 1;          break;
719            case 'z': do_zip_file = 1;          break;
720            case 'o': use_outfile = optarg;     break;
721            case 's': use_socket = 1;           break;
722            case 'v': break;  // compatibility no-op
723            case 'q': do_vibrate = 0;           break;
724            case 'p': do_fb = 1;                break;
725            case 'P': do_update_progress = 1;   break;
726            case 'B': do_broadcast = 1;         break;
727            case '?': printf("\n");
728            case 'h':
729                usage();
730                exit(1);
731        }
732    }
733
734    if ((do_zip_file || do_add_date || do_update_progress || do_broadcast) && !use_outfile) {
735        usage();
736        exit(1);
737    }
738
739    if (do_update_progress && !do_broadcast) {
740        usage();
741        exit(1);
742    }
743
744    // If we are going to use a socket, do it as early as possible
745    // to avoid timeouts from bugreport.
746    if (use_socket) {
747        redirect_to_socket(stdout, "dumpstate");
748    }
749
750    /* redirect output if needed */
751    std::string text_path, zip_path, tmp_path, entry_name;
752
753    /* pointer to the actual path, be it zip or text */
754    std::string path;
755
756    time_t now = time(NULL);
757
758    bool is_redirecting = !use_socket && use_outfile;
759
760    if (is_redirecting) {
761        text_path = use_outfile;
762        if (do_add_date) {
763            char date[80];
764            strftime(date, sizeof(date), "-%Y-%m-%d-%H-%M-%S", localtime(&now));
765            text_path += date;
766        }
767        if (do_fb) {
768            screenshot_path = text_path + ".png";
769        }
770        zip_path = text_path + ".zip";
771        text_path += ".txt";
772        tmp_path = text_path + ".tmp";
773        entry_name = basename(text_path.c_str());
774
775        ALOGD("Temporary path: %s\ntext path: %s\nzip path: %s\nzip entry: %s",
776              tmp_path.c_str(), text_path.c_str(), zip_path.c_str(), entry_name.c_str());
777
778        if (do_update_progress) {
779            if (!entry_name.empty()) {
780                std::vector<std::string> am_args = {
781                     "--receiver-permission", "android.permission.DUMP",
782                     "--es", "android.intent.extra.NAME", entry_name,
783                     "--ei", "android.intent.extra.PID", std::to_string(getpid()),
784                     "--ei", "android.intent.extra.MAX", std::to_string(WEIGHT_TOTAL),
785                };
786                send_broadcast("android.intent.action.BUGREPORT_STARTED", am_args);
787            } else {
788                ALOGE("Skipping started broadcast because entry name could not be inferred\n");
789            }
790        }
791    }
792
793    /* open the vibrator before dropping root */
794    std::unique_ptr<FILE, int(*)(FILE*)> vibrator(NULL, fclose);
795    if (do_vibrate) {
796        vibrator.reset(fopen("/sys/class/timed_output/vibrator/enable", "we"));
797        if (vibrator) {
798            vibrate(vibrator.get(), 150);
799        }
800    }
801
802    /* read /proc/cmdline before dropping root */
803    FILE *cmdline = fopen("/proc/cmdline", "re");
804    if (cmdline) {
805        fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
806        fclose(cmdline);
807    }
808
809    /* collect stack traces from Dalvik and native processes (needs root) */
810    dump_traces_path = dump_traces();
811
812    /* Get the tombstone fds here while we are running as root. */
813    get_tombstone_fds(tombstone_data);
814
815    /* ensure we will keep capabilities when we drop root */
816    if (prctl(PR_SET_KEEPCAPS, 1) < 0) {
817        ALOGE("prctl(PR_SET_KEEPCAPS) failed: %s\n", strerror(errno));
818        return -1;
819    }
820
821    /* switch to non-root user and group */
822    gid_t groups[] = { AID_LOG, AID_SDCARD_R, AID_SDCARD_RW,
823            AID_MOUNT, AID_INET, AID_NET_BW_STATS, AID_READPROC };
824    if (setgroups(sizeof(groups)/sizeof(groups[0]), groups) != 0) {
825        ALOGE("Unable to setgroups, aborting: %s\n", strerror(errno));
826        return -1;
827    }
828    if (setgid(AID_SHELL) != 0) {
829        ALOGE("Unable to setgid, aborting: %s\n", strerror(errno));
830        return -1;
831    }
832    if (setuid(AID_SHELL) != 0) {
833        ALOGE("Unable to setuid, aborting: %s\n", strerror(errno));
834        return -1;
835    }
836
837    struct __user_cap_header_struct capheader;
838    struct __user_cap_data_struct capdata[2];
839    memset(&capheader, 0, sizeof(capheader));
840    memset(&capdata, 0, sizeof(capdata));
841    capheader.version = _LINUX_CAPABILITY_VERSION_3;
842    capheader.pid = 0;
843
844    capdata[CAP_TO_INDEX(CAP_SYSLOG)].permitted = CAP_TO_MASK(CAP_SYSLOG);
845    capdata[CAP_TO_INDEX(CAP_SYSLOG)].effective = CAP_TO_MASK(CAP_SYSLOG);
846    capdata[0].inheritable = 0;
847    capdata[1].inheritable = 0;
848
849    if (capset(&capheader, &capdata[0]) < 0) {
850        ALOGE("capset failed: %s\n", strerror(errno));
851        return -1;
852    }
853
854    if (is_redirecting) {
855        ALOGD("Temporary path: %s\ntext path: %s\nzip path: %s\nzip entry: %s",
856              tmp_path.c_str(), text_path.c_str(), zip_path.c_str(), entry_name.c_str());
857        /* TODO: rather than generating a text file now and zipping it later,
858           it would be more efficient to redirect stdout to the zip entry
859           directly, but the libziparchive doesn't support that option yet. */
860        redirect_to_file(stdout, const_cast<char*>(tmp_path.c_str()));
861    }
862
863    dumpstate();
864
865    /* done */
866    if (vibrator) {
867        for (int i = 0; i < 3; i++) {
868            vibrate(vibrator.get(), 75);
869            usleep((75 + 50) * 1000);
870        }
871    }
872
873    /* close output if needed */
874    if (is_redirecting) {
875        fclose(stdout);
876    }
877
878    /* rename or zip the (now complete) .tmp file to its final location */
879    if (use_outfile) {
880        bool do_text_file = true;
881        if (do_zip_file) {
882            path = zip_path;
883            if (!generate_zip_file(tmp_path, zip_path, entry_name, now)) {
884                ALOGE("Failed to generate zip file; sending text bugreport instead\n");
885                do_text_file = true;
886            } else {
887                do_text_file = false;
888            }
889        }
890        if (do_text_file) {
891            path = text_path;
892            if (rename(tmp_path.c_str(), text_path.c_str())) {
893                ALOGE("rename(%s, %s): %s\n", tmp_path.c_str(), text_path.c_str(), strerror(errno));
894                path.clear();
895            }
896        }
897    }
898
899    /* tell activity manager we're done */
900    if (do_broadcast) {
901        if (!path.empty()) {
902            ALOGI("Final bugreport path: %s\n", path.c_str());
903            std::vector<std::string> am_args = {
904                 "--receiver-permission", "android.permission.DUMP",
905                 "--ei", "android.intent.extra.PID", std::to_string(getpid()),
906                 "--es", "android.intent.extra.BUGREPORT", path
907            };
908            if (do_fb) {
909                am_args.push_back("--es");
910                am_args.push_back("android.intent.extra.SCREENSHOT");
911                am_args.push_back(screenshot_path);
912            }
913            send_broadcast("android.intent.action.BUGREPORT_FINISHED", am_args);
914        } else {
915            ALOGE("Skipping finished broadcast because bugreport could not be generated\n");
916        }
917    }
918
919    ALOGI("done\n");
920
921    return 0;
922}
923