utils.cpp revision fdf52d3697aa0396bd9d8883892937b99a6772a0
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 <poll.h>
22#include <signal.h>
23#include <stdarg.h>
24#include <stdio.h>
25#include <stdlib.h>
26#include <string>
27#include <string.h>
28#include <sys/inotify.h>
29#include <sys/stat.h>
30#include <sys/sysconf.h>
31#include <sys/time.h>
32#include <sys/wait.h>
33#include <sys/klog.h>
34#include <time.h>
35#include <unistd.h>
36#include <vector>
37#include <sys/prctl.h>
38
39#define LOG_TAG "dumpstate"
40#include <cutils/debugger.h>
41#include <cutils/log.h>
42#include <cutils/properties.h>
43#include <cutils/sockets.h>
44#include <private/android_filesystem_config.h>
45
46#include <selinux/android.h>
47
48#include "dumpstate.h"
49
50static const int64_t NANOS_PER_SEC = 1000000000;
51
52/* list of native processes to include in the native dumps */
53static const char* native_processes_to_dump[] = {
54        "/system/bin/audioserver",
55        "/system/bin/cameraserver",
56        "/system/bin/drmserver",
57        "/system/bin/mediaserver",
58        "/system/bin/sdcard",
59        "/system/bin/surfaceflinger",
60        "/system/bin/vehicle_network_service",
61        NULL,
62};
63
64DurationReporter::DurationReporter(const char *title) : DurationReporter(title, stdout) {}
65
66DurationReporter::DurationReporter(const char *title, FILE *out) {
67    title_ = title;
68    if (title) {
69        started_ = DurationReporter::nanotime();
70    }
71    out_ = out;
72}
73
74DurationReporter::~DurationReporter() {
75    if (title_) {
76        uint64_t elapsed = DurationReporter::nanotime() - started_;
77        // Use "Yoda grammar" to make it easier to grep|sort sections.
78        if (out_) {
79            fprintf(out_, "------ %.3fs was the duration of '%s' ------\n",
80                   (float) elapsed / NANOS_PER_SEC, title_);
81        } else {
82            MYLOGD("Duration of '%s': %.3fs\n", title_, (float) elapsed / NANOS_PER_SEC);
83        }
84    }
85}
86
87uint64_t DurationReporter::DurationReporter::nanotime() {
88    struct timespec ts;
89    clock_gettime(CLOCK_MONOTONIC, &ts);
90    return (uint64_t) ts.tv_sec * NANOS_PER_SEC + ts.tv_nsec;
91}
92
93void for_each_userid(void (*func)(int), const char *header) {
94    ON_DRY_RUN_RETURN();
95    DIR *d;
96    struct dirent *de;
97
98    if (header) printf("\n------ %s ------\n", header);
99    func(0);
100
101    if (!(d = opendir("/data/system/users"))) {
102        printf("Failed to open /data/system/users (%s)\n", strerror(errno));
103        return;
104    }
105
106    while ((de = readdir(d))) {
107        int userid;
108        if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
109            continue;
110        }
111        func(userid);
112    }
113
114    closedir(d);
115}
116
117static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
118    DIR *d;
119    struct dirent *de;
120
121    if (!(d = opendir("/proc"))) {
122        printf("Failed to open /proc (%s)\n", strerror(errno));
123        return;
124    }
125
126    if (header) printf("\n------ %s ------\n", header);
127    while ((de = readdir(d))) {
128        int pid;
129        int fd;
130        char cmdpath[255];
131        char cmdline[255];
132
133        if (!(pid = atoi(de->d_name))) {
134            continue;
135        }
136
137        memset(cmdline, 0, sizeof(cmdline));
138
139        snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
140        if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
141            TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
142            close(fd);
143            if (cmdline[0]) {
144                helper(pid, cmdline, arg);
145                continue;
146            }
147        }
148
149        // if no cmdline, a kernel thread has comm
150        snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
151        if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
152            TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
153            close(fd);
154            if (cmdline[1]) {
155                cmdline[0] = '[';
156                size_t len = strcspn(cmdline, "\f\b\r\n");
157                cmdline[len] = ']';
158                cmdline[len+1] = '\0';
159            }
160        }
161        if (!cmdline[0]) {
162            strcpy(cmdline, "N/A");
163        }
164        helper(pid, cmdline, arg);
165    }
166
167    closedir(d);
168}
169
170static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
171    for_each_pid_func *func = (for_each_pid_func*) arg;
172    func(pid, cmdline);
173}
174
175void for_each_pid(for_each_pid_func func, const char *header) {
176    ON_DRY_RUN_RETURN();
177  __for_each_pid(for_each_pid_helper, header, (void *)func);
178}
179
180static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
181    DIR *d;
182    struct dirent *de;
183    char taskpath[255];
184    for_each_tid_func *func = (for_each_tid_func *) arg;
185
186    sprintf(taskpath, "/proc/%d/task", pid);
187
188    if (!(d = opendir(taskpath))) {
189        printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
190        return;
191    }
192
193    func(pid, pid, cmdline);
194
195    while ((de = readdir(d))) {
196        int tid;
197        int fd;
198        char commpath[255];
199        char comm[255];
200
201        if (!(tid = atoi(de->d_name))) {
202            continue;
203        }
204
205        if (tid == pid)
206            continue;
207
208        sprintf(commpath,"/proc/%d/comm", tid);
209        memset(comm, 0, sizeof(comm));
210        if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
211            strcpy(comm, "N/A");
212        } else {
213            char *c;
214            TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
215            close(fd);
216
217            c = strrchr(comm, '\n');
218            if (c) {
219                *c = '\0';
220            }
221        }
222        func(pid, tid, comm);
223    }
224
225    closedir(d);
226}
227
228void for_each_tid(for_each_tid_func func, const char *header) {
229    ON_DRY_RUN_RETURN();
230    __for_each_pid(for_each_tid_helper, header, (void *) func);
231}
232
233void show_wchan(int pid, int tid, const char *name) {
234    ON_DRY_RUN_RETURN();
235    char path[255];
236    char buffer[255];
237    int fd, ret, save_errno;
238    char name_buffer[255];
239
240    memset(buffer, 0, sizeof(buffer));
241
242    sprintf(path, "/proc/%d/wchan", tid);
243    if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
244        printf("Failed to open '%s' (%s)\n", path, strerror(errno));
245        return;
246    }
247
248    ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
249    save_errno = errno;
250    close(fd);
251
252    if (ret < 0) {
253        printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
254        return;
255    }
256
257    snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
258             pid == tid ? 0 : 3, "", name);
259
260    printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
261
262    return;
263}
264
265// print time in centiseconds
266static void snprcent(char *buffer, size_t len, size_t spc,
267                     unsigned long long time) {
268    static long hz; // cache discovered hz
269
270    if (hz <= 0) {
271        hz = sysconf(_SC_CLK_TCK);
272        if (hz <= 0) {
273            hz = 1000;
274        }
275    }
276
277    // convert to centiseconds
278    time = (time * 100 + (hz / 2)) / hz;
279
280    char str[16];
281
282    snprintf(str, sizeof(str), " %llu.%02u",
283             time / 100, (unsigned)(time % 100));
284    size_t offset = strlen(buffer);
285    snprintf(buffer + offset, (len > offset) ? len - offset : 0,
286             "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
287}
288
289// print permille as a percent
290static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
291    char str[16];
292
293    snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
294    size_t offset = strlen(buffer);
295    snprintf(buffer + offset, (len > offset) ? len - offset : 0,
296             "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
297}
298
299void show_showtime(int pid, const char *name) {
300    ON_DRY_RUN_RETURN();
301    char path[255];
302    char buffer[1023];
303    int fd, ret, save_errno;
304
305    memset(buffer, 0, sizeof(buffer));
306
307    sprintf(path, "/proc/%d/stat", pid);
308    if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
309        printf("Failed to open '%s' (%s)\n", path, strerror(errno));
310        return;
311    }
312
313    ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
314    save_errno = errno;
315    close(fd);
316
317    if (ret < 0) {
318        printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
319        return;
320    }
321
322    // field 14 is utime
323    // field 15 is stime
324    // field 42 is iotime
325    unsigned long long utime = 0, stime = 0, iotime = 0;
326    if (sscanf(buffer,
327               "%*llu %*s %*s %*lld %*lld %*lld %*lld %*lld %*lld %*lld %*lld "
328               "%*lld %*lld %llu %llu %*lld %*lld %*lld %*lld %*lld %*lld "
329               "%*lld %*lld %*lld %*lld %*lld %*lld %*lld %*lld %*lld %*lld "
330               "%*lld %*lld %*lld %*lld %*lld %*lld %*lld %*lld %*lld %llu ",
331               &utime, &stime, &iotime) != 3) {
332        return;
333    }
334
335    unsigned long long total = utime + stime;
336    if (!total) {
337        return;
338    }
339
340    unsigned permille = (iotime * 1000 + (total / 2)) / total;
341    if (permille > 1000) {
342        permille = 1000;
343    }
344
345    // try to beautify and stabilize columns at <80 characters
346    snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
347    if ((name[0] != '[') || utime) {
348        snprcent(buffer, sizeof(buffer), 57, utime);
349    }
350    snprcent(buffer, sizeof(buffer), 65, stime);
351    if ((name[0] != '[') || iotime) {
352        snprcent(buffer, sizeof(buffer), 73, iotime);
353    }
354    if (iotime) {
355        snprdec(buffer, sizeof(buffer), 79, permille);
356    }
357    puts(buffer); // adds a trailing newline
358
359    return;
360}
361
362void do_dmesg() {
363    const char *title = "KERNEL LOG (dmesg)";
364    DurationReporter duration_reporter(title);
365    printf("------ %s ------\n", title);
366
367    ON_DRY_RUN_RETURN();
368    /* Get size of kernel buffer */
369    int size = klogctl(KLOG_SIZE_BUFFER, NULL, 0);
370    if (size <= 0) {
371        printf("Unexpected klogctl return value: %d\n\n", size);
372        return;
373    }
374    char *buf = (char *) malloc(size + 1);
375    if (buf == NULL) {
376        printf("memory allocation failed\n\n");
377        return;
378    }
379    int retval = klogctl(KLOG_READ_ALL, buf, size);
380    if (retval < 0) {
381        printf("klogctl failure\n\n");
382        free(buf);
383        return;
384    }
385    buf[retval] = '\0';
386    printf("%s\n\n", buf);
387    free(buf);
388    return;
389}
390
391void do_showmap(int pid, const char *name) {
392    char title[255];
393    char arg[255];
394
395    sprintf(title, "SHOW MAP %d (%s)", pid, name);
396    sprintf(arg, "%d", pid);
397    run_command(title, 10, SU_PATH, "root", "showmap", arg, NULL);
398}
399
400static int _dump_file_from_fd(const char *title, const char *path, int fd) {
401    if (title) {
402        printf("------ %s (%s", title, path);
403
404        struct stat st;
405        // Only show the modification time of non-device files.
406        size_t path_len = strlen(path);
407        if ((path_len < 6 || memcmp(path, "/proc/", 6)) &&
408                (path_len < 5 || memcmp(path, "/sys/", 5)) &&
409                (path_len < 3 || memcmp(path, "/d/", 3)) &&
410                !fstat(fd, &st)) {
411            char stamp[80];
412            time_t mtime = st.st_mtime;
413            strftime(stamp, sizeof(stamp), "%Y-%m-%d %H:%M:%S", localtime(&mtime));
414            printf(": %s", stamp);
415        }
416        printf(") ------\n");
417    }
418    ON_DRY_RUN({ update_progress(WEIGHT_FILE); close(fd); return 0; });
419
420    bool newline = false;
421    fd_set read_set;
422    struct timeval tm;
423    while (1) {
424        FD_ZERO(&read_set);
425        FD_SET(fd, &read_set);
426        /* Timeout if no data is read for 30 seconds. */
427        tm.tv_sec = 30;
428        tm.tv_usec = 0;
429        uint64_t elapsed = DurationReporter::nanotime();
430        int ret = TEMP_FAILURE_RETRY(select(fd + 1, &read_set, NULL, NULL, &tm));
431        if (ret == -1) {
432            printf("*** %s: select failed: %s\n", path, strerror(errno));
433            newline = true;
434            break;
435        } else if (ret == 0) {
436            elapsed = DurationReporter::nanotime() - elapsed;
437            printf("*** %s: Timed out after %.3fs\n", path,
438                   (float) elapsed / NANOS_PER_SEC);
439            newline = true;
440            break;
441        } else {
442            char buffer[65536];
443            ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
444            if (bytes_read > 0) {
445                fwrite(buffer, bytes_read, 1, stdout);
446                newline = (buffer[bytes_read-1] == '\n');
447            } else {
448                if (bytes_read == -1) {
449                    printf("*** %s: Failed to read from fd: %s", path, strerror(errno));
450                    newline = true;
451                }
452                break;
453            }
454        }
455    }
456    update_progress(WEIGHT_FILE);
457    close(fd);
458
459    if (!newline) printf("\n");
460    if (title) printf("\n");
461    return 0;
462}
463
464/* prints the contents of a file */
465int dump_file(const char *title, const char *path) {
466    DurationReporter duration_reporter(title);
467    int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
468    if (fd < 0) {
469        int err = errno;
470        printf("*** %s: %s\n", path, strerror(err));
471        if (title) printf("\n");
472        return -1;
473    }
474    return _dump_file_from_fd(title, path, fd);
475}
476
477/* calls skip to gate calling dump_from_fd recursively
478 * in the specified directory. dump_from_fd defaults to
479 * dump_file_from_fd above when set to NULL. skip defaults
480 * to false when set to NULL. dump_from_fd will always be
481 * called with title NULL.
482 */
483int dump_files(const char *title, const char *dir,
484        bool (*skip)(const char *path),
485        int (*dump_from_fd)(const char *title, const char *path, int fd)) {
486    DurationReporter duration_reporter(title);
487    DIR *dirp;
488    struct dirent *d;
489    char *newpath = NULL;
490    const char *slash = "/";
491    int fd, retval = 0;
492
493    if (title) {
494        printf("------ %s (%s) ------\n", title, dir);
495    }
496    ON_DRY_RUN_RETURN(0);
497
498    if (dir[strlen(dir) - 1] == '/') {
499        ++slash;
500    }
501    dirp = opendir(dir);
502    if (dirp == NULL) {
503        retval = -errno;
504        fprintf(stderr, "%s: %s\n", dir, strerror(errno));
505        return retval;
506    }
507
508    if (!dump_from_fd) {
509        dump_from_fd = dump_file_from_fd;
510    }
511    for (; ((d = readdir(dirp))); free(newpath), newpath = NULL) {
512        if ((d->d_name[0] == '.')
513         && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
514          || (d->d_name[1] == '\0'))) {
515            continue;
516        }
517        asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
518                 (d->d_type == DT_DIR) ? "/" : "");
519        if (!newpath) {
520            retval = -errno;
521            continue;
522        }
523        if (skip && (*skip)(newpath)) {
524            continue;
525        }
526        if (d->d_type == DT_DIR) {
527            int ret = dump_files(NULL, newpath, skip, dump_from_fd);
528            if (ret < 0) {
529                retval = ret;
530            }
531            continue;
532        }
533        fd = TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
534        if (fd < 0) {
535            retval = fd;
536            printf("*** %s: %s\n", newpath, strerror(errno));
537            continue;
538        }
539        (*dump_from_fd)(NULL, newpath, fd);
540    }
541    closedir(dirp);
542    if (title) {
543        printf("\n");
544    }
545    return retval;
546}
547
548/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
549 * it's possible to avoid issues where opening the file itself can get
550 * stuck.
551 */
552int dump_file_from_fd(const char *title, const char *path, int fd) {
553    int flags = fcntl(fd, F_GETFL);
554    if (flags == -1) {
555        printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
556        close(fd);
557        return -1;
558    } else if (!(flags & O_NONBLOCK)) {
559        printf("*** %s: fd must have O_NONBLOCK set.\n", path);
560        close(fd);
561        return -1;
562    }
563    return _dump_file_from_fd(title, path, fd);
564}
565
566bool waitpid_with_timeout(pid_t pid, int timeout_seconds, int* status) {
567    sigset_t child_mask, old_mask;
568    sigemptyset(&child_mask);
569    sigaddset(&child_mask, SIGCHLD);
570
571    if (sigprocmask(SIG_BLOCK, &child_mask, &old_mask) == -1) {
572        printf("*** sigprocmask failed: %s\n", strerror(errno));
573        return false;
574    }
575
576    struct timespec ts;
577    ts.tv_sec = timeout_seconds;
578    ts.tv_nsec = 0;
579    int ret = TEMP_FAILURE_RETRY(sigtimedwait(&child_mask, NULL, &ts));
580    int saved_errno = errno;
581    // Set the signals back the way they were.
582    if (sigprocmask(SIG_SETMASK, &old_mask, NULL) == -1) {
583        printf("*** sigprocmask failed: %s\n", strerror(errno));
584        if (ret == 0) {
585            return false;
586        }
587    }
588    if (ret == -1) {
589        errno = saved_errno;
590        if (errno == EAGAIN) {
591            errno = ETIMEDOUT;
592        } else {
593            printf("*** sigtimedwait failed: %s\n", strerror(errno));
594        }
595        return false;
596    }
597
598    pid_t child_pid = waitpid(pid, status, WNOHANG);
599    if (child_pid != pid) {
600        if (child_pid != -1) {
601            printf("*** Waiting for pid %d, got pid %d instead\n", pid, child_pid);
602        } else {
603            printf("*** waitpid failed: %s\n", strerror(errno));
604        }
605        return false;
606    }
607    return true;
608}
609
610int run_command(const char *title, int timeout_seconds, const char *command, ...) {
611    DurationReporter duration_reporter(title);
612    fflush(stdout);
613
614    const char *args[1024] = {command};
615    size_t arg;
616    va_list ap;
617    va_start(ap, command);
618    if (title) printf("------ %s (%s", title, command);
619    for (arg = 1; arg < sizeof(args) / sizeof(args[0]); ++arg) {
620        args[arg] = va_arg(ap, const char *);
621        if (args[arg] == NULL) break;
622        if (title) printf(" %s", args[arg]);
623    }
624    if (title) printf(") ------\n");
625    fflush(stdout);
626
627    ON_DRY_RUN({ update_progress(timeout_seconds); va_end(ap); return 0; });
628
629    int status = run_command_always(title, timeout_seconds, args);
630    va_end(ap);
631    return status;
632}
633
634/* forks a command and waits for it to finish */
635int run_command_always(const char *title, int timeout_seconds, const char *args[]) {
636    /* TODO: for now we're simplifying the progress calculation by using the timeout as the weight.
637     * It's a good approximation for most cases, except when calling dumpsys, where its weight
638     * should be much higher proportionally to its timeout. */
639    int weight = timeout_seconds;
640
641    const char *command = args[0];
642    uint64_t start = DurationReporter::nanotime();
643    pid_t pid = fork();
644
645    /* handle error case */
646    if (pid < 0) {
647        printf("*** fork: %s\n", strerror(errno));
648        return pid;
649    }
650
651    /* handle child case */
652    if (pid == 0) {
653
654        /* make sure the child dies when dumpstate dies */
655        prctl(PR_SET_PDEATHSIG, SIGKILL);
656
657        /* just ignore SIGPIPE, will go down with parent's */
658        struct sigaction sigact;
659        memset(&sigact, 0, sizeof(sigact));
660        sigact.sa_handler = SIG_IGN;
661        sigaction(SIGPIPE, &sigact, NULL);
662
663        execvp(command, (char**) args);
664        printf("*** exec(%s): %s\n", command, strerror(errno));
665        fflush(stdout);
666        _exit(-1);
667    }
668
669    /* handle parent case */
670    int status;
671    bool ret = waitpid_with_timeout(pid, timeout_seconds, &status);
672    uint64_t elapsed = DurationReporter::nanotime() - start;
673    if (!ret) {
674        if (errno == ETIMEDOUT) {
675            printf("*** %s: Timed out after %.3fs (killing pid %d)\n", command,
676                   (float) elapsed / NANOS_PER_SEC, pid);
677        } else {
678            printf("*** %s: Error after %.4fs (killing pid %d)\n", command,
679                   (float) elapsed / NANOS_PER_SEC, pid);
680        }
681        kill(pid, SIGTERM);
682        if (!waitpid_with_timeout(pid, 5, NULL)) {
683            kill(pid, SIGKILL);
684            if (!waitpid_with_timeout(pid, 5, NULL)) {
685                printf("*** %s: Cannot kill %d even with SIGKILL.\n", command, pid);
686            }
687        }
688        return -1;
689    }
690
691    if (WIFSIGNALED(status)) {
692        printf("*** %s: Killed by signal %d\n", command, WTERMSIG(status));
693    } else if (WIFEXITED(status) && WEXITSTATUS(status) > 0) {
694        printf("*** %s: Exit code %d\n", command, WEXITSTATUS(status));
695    }
696
697    if (weight > 0) {
698        update_progress(weight);
699    }
700    return status;
701}
702
703void send_broadcast(const std::string& action, const std::vector<std::string>& args) {
704    if (args.size() > 1000) {
705        fprintf(stderr, "send_broadcast: too many arguments (%d)\n", (int) args.size());
706        return;
707    }
708    const char *am_args[1024] = { "/system/bin/am", "broadcast",
709                                  "--user", "0", "-a", action.c_str() };
710    size_t am_index = 5; // Starts at the index of last initial value above.
711    for (const std::string& arg : args) {
712        am_args[++am_index] = arg.c_str();
713    }
714    // Always terminate with NULL.
715    am_args[am_index + 1] = NULL;
716    run_command_always(NULL, 5, am_args);
717}
718
719size_t num_props = 0;
720static char* props[2000];
721
722static void print_prop(const char *key, const char *name, void *user) {
723    (void) user;
724    if (num_props < sizeof(props) / sizeof(props[0])) {
725        char buf[PROPERTY_KEY_MAX + PROPERTY_VALUE_MAX + 10];
726        snprintf(buf, sizeof(buf), "[%s]: [%s]\n", key, name);
727        props[num_props++] = strdup(buf);
728    }
729}
730
731static int compare_prop(const void *a, const void *b) {
732    return strcmp(*(char * const *) a, *(char * const *) b);
733}
734
735/* prints all the system properties */
736void print_properties() {
737    const char* title = "SYSTEM PROPERTIES";
738    DurationReporter duration_reporter(title);
739    printf("------ %s ------\n", title);
740    ON_DRY_RUN_RETURN();
741    size_t i;
742    num_props = 0;
743    property_list(print_prop, NULL);
744    qsort(&props, num_props, sizeof(props[0]), compare_prop);
745
746    for (i = 0; i < num_props; ++i) {
747        fputs(props[i], stdout);
748        free(props[i]);
749    }
750    printf("\n");
751}
752
753/* redirect output to a service control socket */
754void redirect_to_socket(FILE *redirect, const char *service) {
755    int s = android_get_control_socket(service);
756    if (s < 0) {
757        fprintf(stderr, "android_get_control_socket(%s): %s\n", service, strerror(errno));
758        exit(1);
759    }
760    fcntl(s, F_SETFD, FD_CLOEXEC);
761    if (listen(s, 4) < 0) {
762        fprintf(stderr, "listen(control socket): %s\n", strerror(errno));
763        exit(1);
764    }
765
766    struct sockaddr addr;
767    socklen_t alen = sizeof(addr);
768    int fd = accept(s, &addr, &alen);
769    if (fd < 0) {
770        fprintf(stderr, "accept(control socket): %s\n", strerror(errno));
771        exit(1);
772    }
773
774    fflush(redirect);
775    dup2(fd, fileno(redirect));
776    close(fd);
777}
778
779void create_parent_dirs(const char *path) {
780    char *chp = const_cast<char *> (path);
781
782    /* skip initial slash */
783    if (chp[0] == '/')
784        chp++;
785
786    /* create leading directories, if necessary */
787    struct stat dir_stat;
788    while (chp && chp[0]) {
789        chp = strchr(chp, '/');
790        if (chp) {
791            *chp = 0;
792            if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
793                MYLOGI("Creating directory %s\n", path);
794                if (mkdir(path, 0770)) { /* drwxrwx--- */
795                    MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
796                } else if (chown(path, AID_SHELL, AID_SHELL)) {
797                    MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
798                }
799            }
800            *chp++ = '/';
801        }
802    }
803}
804
805/* redirect output to a file */
806void redirect_to_file(FILE *redirect, char *path) {
807    create_parent_dirs(path);
808
809    int fd = TEMP_FAILURE_RETRY(open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
810                                     S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
811    if (fd < 0) {
812        fprintf(stderr, "%s: %s\n", path, strerror(errno));
813        exit(1);
814    }
815
816    TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
817    close(fd);
818}
819
820static bool should_dump_native_traces(const char* path) {
821    for (const char** p = native_processes_to_dump; *p; p++) {
822        if (!strcmp(*p, path)) {
823            return true;
824        }
825    }
826    return false;
827}
828
829/* dump Dalvik and native stack traces, return the trace file location (NULL if none) */
830const char *dump_traces() {
831    DurationReporter duration_reporter("DUMP TRACES", NULL);
832    ON_DRY_RUN_RETURN(NULL);
833    const char* result = NULL;
834
835    char traces_path[PROPERTY_VALUE_MAX] = "";
836    property_get("dalvik.vm.stack-trace-file", traces_path, "");
837    if (!traces_path[0]) return NULL;
838
839    /* move the old traces.txt (if any) out of the way temporarily */
840    char anr_traces_path[PATH_MAX];
841    strlcpy(anr_traces_path, traces_path, sizeof(anr_traces_path));
842    strlcat(anr_traces_path, ".anr", sizeof(anr_traces_path));
843    if (rename(traces_path, anr_traces_path) && errno != ENOENT) {
844        fprintf(stderr, "rename(%s, %s): %s\n", traces_path, anr_traces_path, strerror(errno));
845        return NULL;  // Can't rename old traces.txt -- no permission? -- leave it alone instead
846    }
847
848    /* create a new, empty traces.txt file to receive stack dumps */
849    int fd = TEMP_FAILURE_RETRY(open(traces_path, O_CREAT | O_WRONLY | O_TRUNC | O_NOFOLLOW | O_CLOEXEC,
850                                     0666));  /* -rw-rw-rw- */
851    if (fd < 0) {
852        fprintf(stderr, "%s: %s\n", traces_path, strerror(errno));
853        return NULL;
854    }
855    int chmod_ret = fchmod(fd, 0666);
856    if (chmod_ret < 0) {
857        fprintf(stderr, "fchmod on %s failed: %s\n", traces_path, strerror(errno));
858        close(fd);
859        return NULL;
860    }
861
862    /* Variables below must be initialized before 'goto' statements */
863    int dalvik_found = 0;
864    int ifd, wfd = -1;
865
866    /* walk /proc and kill -QUIT all Dalvik processes */
867    DIR *proc = opendir("/proc");
868    if (proc == NULL) {
869        fprintf(stderr, "/proc: %s\n", strerror(errno));
870        goto error_close_fd;
871    }
872
873    /* use inotify to find when processes are done dumping */
874    ifd = inotify_init();
875    if (ifd < 0) {
876        fprintf(stderr, "inotify_init: %s\n", strerror(errno));
877        goto error_close_fd;
878    }
879
880    wfd = inotify_add_watch(ifd, traces_path, IN_CLOSE_WRITE);
881    if (wfd < 0) {
882        fprintf(stderr, "inotify_add_watch(%s): %s\n", traces_path, strerror(errno));
883        goto error_close_ifd;
884    }
885
886    struct dirent *d;
887    while ((d = readdir(proc))) {
888        int pid = atoi(d->d_name);
889        if (pid <= 0) continue;
890
891        char path[PATH_MAX];
892        char data[PATH_MAX];
893        snprintf(path, sizeof(path), "/proc/%d/exe", pid);
894        ssize_t len = readlink(path, data, sizeof(data) - 1);
895        if (len <= 0) {
896            continue;
897        }
898        data[len] = '\0';
899
900        if (!strncmp(data, "/system/bin/app_process", strlen("/system/bin/app_process"))) {
901            /* skip zygote -- it won't dump its stack anyway */
902            snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
903            int cfd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC));
904            len = read(cfd, data, sizeof(data) - 1);
905            close(cfd);
906            if (len <= 0) {
907                continue;
908            }
909            data[len] = '\0';
910            if (!strncmp(data, "zygote", strlen("zygote"))) {
911                continue;
912            }
913
914            ++dalvik_found;
915            uint64_t start = DurationReporter::nanotime();
916            if (kill(pid, SIGQUIT)) {
917                fprintf(stderr, "kill(%d, SIGQUIT): %s\n", pid, strerror(errno));
918                continue;
919            }
920
921            /* wait for the writable-close notification from inotify */
922            struct pollfd pfd = { ifd, POLLIN, 0 };
923            int ret = poll(&pfd, 1, 5000);  /* 5 sec timeout */
924            if (ret < 0) {
925                fprintf(stderr, "poll: %s\n", strerror(errno));
926            } else if (ret == 0) {
927                fprintf(stderr, "warning: timed out dumping pid %d\n", pid);
928            } else {
929                struct inotify_event ie;
930                read(ifd, &ie, sizeof(ie));
931            }
932
933            if (lseek(fd, 0, SEEK_END) < 0) {
934                fprintf(stderr, "lseek: %s\n", strerror(errno));
935            } else {
936                dprintf(fd, "[dump dalvik stack %d: %.3fs elapsed]\n",
937                        pid, (float)(DurationReporter::nanotime() - start) / NANOS_PER_SEC);
938            }
939        } else if (should_dump_native_traces(data)) {
940            /* dump native process if appropriate */
941            if (lseek(fd, 0, SEEK_END) < 0) {
942                fprintf(stderr, "lseek: %s\n", strerror(errno));
943            } else {
944                static uint16_t timeout_failures = 0;
945                uint64_t start = DurationReporter::nanotime();
946
947                /* If 3 backtrace dumps fail in a row, consider debuggerd dead. */
948                if (timeout_failures == 3) {
949                    dprintf(fd, "too many stack dump failures, skipping...\n");
950                } else if (dump_backtrace_to_file_timeout(pid, fd, 20) == -1) {
951                    dprintf(fd, "dumping failed, likely due to a timeout\n");
952                    timeout_failures++;
953                } else {
954                    timeout_failures = 0;
955                }
956                dprintf(fd, "[dump native stack %d: %.3fs elapsed]\n",
957                        pid, (float)(DurationReporter::nanotime() - start) / NANOS_PER_SEC);
958            }
959        }
960    }
961
962    if (dalvik_found == 0) {
963        fprintf(stderr, "Warning: no Dalvik processes found to dump stacks\n");
964    }
965
966    static char dump_traces_path[PATH_MAX];
967    strlcpy(dump_traces_path, traces_path, sizeof(dump_traces_path));
968    strlcat(dump_traces_path, ".bugreport", sizeof(dump_traces_path));
969    if (rename(traces_path, dump_traces_path)) {
970        fprintf(stderr, "rename(%s, %s): %s\n", traces_path, dump_traces_path, strerror(errno));
971        goto error_close_ifd;
972    }
973    result = dump_traces_path;
974
975    /* replace the saved [ANR] traces.txt file */
976    rename(anr_traces_path, traces_path);
977
978error_close_ifd:
979    close(ifd);
980error_close_fd:
981    close(fd);
982    return result;
983}
984
985void dump_route_tables() {
986    DurationReporter duration_reporter("DUMP ROUTE TABLES");
987    ON_DRY_RUN_RETURN();
988    const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
989    dump_file("RT_TABLES", RT_TABLES_PATH);
990    FILE* fp = fopen(RT_TABLES_PATH, "re");
991    if (!fp) {
992        printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
993        return;
994    }
995    char table[16];
996    // Each line has an integer (the table number), a space, and a string (the table name). We only
997    // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
998    // Add a fixed max limit so this doesn't go awry.
999    for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
1000        run_command("ROUTE TABLE IPv4", 10, "ip", "-4", "route", "show", "table", table, NULL);
1001        run_command("ROUTE TABLE IPv6", 10, "ip", "-6", "route", "show", "table", table, NULL);
1002    }
1003    fclose(fp);
1004}
1005
1006/* overall progress */
1007int progress = 0;
1008int do_update_progress = 0; // Set by dumpstate.cpp
1009int weight_total = WEIGHT_TOTAL;
1010
1011// TODO: make this function thread safe if sections are generated in parallel.
1012void update_progress(int delta) {
1013    if (!do_update_progress) return;
1014
1015    progress += delta;
1016
1017    char key[PROPERTY_KEY_MAX];
1018    char value[PROPERTY_VALUE_MAX];
1019
1020    // adjusts max on the fly
1021    if (progress > weight_total) {
1022        int new_total = weight_total * 1.2;
1023        fprintf(stderr, "Adjusting total weight from %d to %d\n", weight_total, new_total);
1024        weight_total = new_total;
1025        sprintf(key, "dumpstate.%d.max", getpid());
1026        sprintf(value, "%d", weight_total);
1027        int status = property_set(key, value);
1028        if (status) {
1029            MYLOGE("Could not update max weight by setting system property %s to %s: %d\n",
1030                    key, value, status);
1031        }
1032    }
1033
1034    sprintf(key, "dumpstate.%d.progress", getpid());
1035    sprintf(value, "%d", progress);
1036
1037    // stderr is ignored on normal invocations, but useful when calling /system/bin/dumpstate
1038    // directly for debuggging.
1039    fprintf(stderr, "Setting progress (%s): %s/%d\n", key, value, weight_total);
1040
1041    int status = property_set(key, value);
1042    if (status) {
1043        MYLOGE("Could not update progress by setting system property %s to %s: %d\n",
1044                key, value, status);
1045    }
1046}
1047
1048void take_screenshot(const std::string& path) {
1049    const char *args[] = { "/system/bin/screencap", "-p", path.c_str(), NULL };
1050    run_command_always(NULL, 10, args);
1051}
1052
1053void vibrate(FILE* vibrator, int ms) {
1054    fprintf(vibrator, "%d\n", ms);
1055    fflush(vibrator);
1056}
1057
1058bool is_dir(const char* pathname) {
1059    struct stat info;
1060    if (stat(pathname, &info) == -1) {
1061        return false;
1062    }
1063    return S_ISDIR(info.st_mode);
1064}
1065
1066time_t get_mtime(int fd, time_t default_mtime) {
1067    struct stat info;
1068    if (fstat(fd, &info) == -1) {
1069        return default_mtime;
1070    }
1071    return info.st_mtime;
1072}
1073
1074void dump_emmc_ecsd(const char *ext_csd_path) {
1075    static const size_t EXT_CSD_REV = 192;
1076    static const size_t EXT_PRE_EOL_INFO = 267;
1077    static const size_t EXT_DEVICE_LIFE_TIME_EST_TYP_A = 268;
1078    static const size_t EXT_DEVICE_LIFE_TIME_EST_TYP_B = 269;
1079    struct hex {
1080        char str[2];
1081    } buffer[512];
1082    int fd, ext_csd_rev, ext_pre_eol_info;
1083    ssize_t bytes_read;
1084    static const char *ver_str[] = {
1085        "4.0", "4.1", "4.2", "4.3", "Obsolete", "4.41", "4.5", "5.0"
1086    };
1087    static const char *eol_str[] = {
1088        "Undefined",
1089        "Normal",
1090        "Warning (consumed 80% of reserve)",
1091        "Urgent (consumed 90% of reserve)"
1092    };
1093
1094    printf("------ %s Extended CSD ------\n", ext_csd_path);
1095
1096    fd = TEMP_FAILURE_RETRY(open(ext_csd_path,
1097                                 O_RDONLY | O_NONBLOCK | O_CLOEXEC));
1098    if (fd < 0) {
1099        printf("*** %s: %s\n\n", ext_csd_path, strerror(errno));
1100        return;
1101    }
1102
1103    bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
1104    close(fd);
1105    if (bytes_read < 0) {
1106        printf("*** %s: %s\n\n", ext_csd_path, strerror(errno));
1107        return;
1108    }
1109    if (bytes_read < (ssize_t)(EXT_CSD_REV * sizeof(struct hex))) {
1110        printf("*** %s: truncated content %zd\n\n", ext_csd_path, bytes_read);
1111        return;
1112    }
1113
1114    ext_csd_rev = 0;
1115    if (sscanf(buffer[EXT_CSD_REV].str, "%02x", &ext_csd_rev) != 1) {
1116        printf("*** %s: EXT_CSD_REV parse error \"%.2s\"\n\n",
1117               ext_csd_path, buffer[EXT_CSD_REV].str);
1118        return;
1119    }
1120
1121    printf("rev 1.%d (MMC %s)\n",
1122           ext_csd_rev,
1123           (ext_csd_rev < (int)(sizeof(ver_str) / sizeof(ver_str[0]))) ?
1124               ver_str[ext_csd_rev] :
1125               "Unknown");
1126    if (ext_csd_rev < 7) {
1127        printf("\n");
1128        return;
1129    }
1130
1131    if (bytes_read < (ssize_t)(EXT_PRE_EOL_INFO * sizeof(struct hex))) {
1132        printf("*** %s: truncated content %zd\n\n", ext_csd_path, bytes_read);
1133        return;
1134    }
1135
1136    ext_pre_eol_info = 0;
1137    if (sscanf(buffer[EXT_PRE_EOL_INFO].str, "%02x", &ext_pre_eol_info) != 1) {
1138        printf("*** %s: PRE_EOL_INFO parse error \"%.2s\"\n\n",
1139               ext_csd_path, buffer[EXT_PRE_EOL_INFO].str);
1140        return;
1141    }
1142    printf("PRE_EOL_INFO %d (MMC %s)\n",
1143           ext_pre_eol_info,
1144           eol_str[(ext_pre_eol_info < (int)
1145                       (sizeof(eol_str) / sizeof(eol_str[0]))) ?
1146                           ext_pre_eol_info : 0]);
1147
1148    for (size_t lifetime = EXT_DEVICE_LIFE_TIME_EST_TYP_A;
1149            lifetime <= EXT_DEVICE_LIFE_TIME_EST_TYP_B;
1150            ++lifetime) {
1151        int ext_device_life_time_est;
1152        static const char *est_str[] = {
1153            "Undefined",
1154            "0-10% of device lifetime used",
1155            "10-20% of device lifetime used",
1156            "20-30% of device lifetime used",
1157            "30-40% of device lifetime used",
1158            "40-50% of device lifetime used",
1159            "50-60% of device lifetime used",
1160            "60-70% of device lifetime used",
1161            "70-80% of device lifetime used",
1162            "80-90% of device lifetime used",
1163            "90-100% of device lifetime used",
1164            "Exceeded the maximum estimated device lifetime",
1165        };
1166
1167        if (bytes_read < (ssize_t)(lifetime * sizeof(struct hex))) {
1168            printf("*** %s: truncated content %zd\n", ext_csd_path, bytes_read);
1169            break;
1170        }
1171
1172        ext_device_life_time_est = 0;
1173        if (sscanf(buffer[lifetime].str, "%02x", &ext_device_life_time_est) != 1) {
1174            printf("*** %s: DEVICE_LIFE_TIME_EST_TYP_%c parse error \"%.2s\"\n",
1175                   ext_csd_path,
1176                   (unsigned)(lifetime - EXT_DEVICE_LIFE_TIME_EST_TYP_A) + 'A',
1177                   buffer[lifetime].str);
1178            continue;
1179        }
1180        printf("DEVICE_LIFE_TIME_EST_TYP_%c %d (MMC %s)\n",
1181               (unsigned)(lifetime - EXT_DEVICE_LIFE_TIME_EST_TYP_A) + 'A',
1182               ext_device_life_time_est,
1183               est_str[(ext_device_life_time_est < (int)
1184                           (sizeof(est_str) / sizeof(est_str[0]))) ?
1185                               ext_device_life_time_est : 0]);
1186    }
1187
1188    printf("\n");
1189}
1190