Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f0c58726 authored by Jeff Brown's avatar Jeff Brown
Browse files

Improve stack unwinder robustness. 

Keep track of whether memory maps are readable.  Use the information
in try_get_word to try to avoid accidentally dereferencing an invalid
pointer within the current process.  (Note that I haven't ever
seen that happen during normal unwinding, but it pays to be
a little more careful.)

Refactored try_get_word a little to make it easier to pass it the
needed state for validation checks by way of a little memory_t struct.

Improved how the memory map for the current process is cached.  This is
important because we need up to date information about readable maps.
Use a 5 second cache expiration.

Improved the PC -> LR fallback logic in the unwinder so we can
eke out an extra frame sometimes.

Fixed a bug reading ELF program headers.  The phnum & phentsize
fields are half-words.  We were incorrectly interpreting
phnum as a whole word.

Used android_atomic_* operations carefully in the unwinder
to prevent possible memory races between the dumper and the dumpee.
This was highly unlikely (or even impossible due to the presence
of other barriers along the way) but the code is clearer now about
its invariants.

Fixed a bug in debuggerd where the pid was being passed to have
its stack dump taken instead of the tid, resulting in short
stacks because ptrace couldn't read the data if pid != tid.
Did a full sweep to ensure that we use pid / tid correctly everywhere.

Ported old code from debuggerd to rewind the program counter back
one instruction so that it points to the branch instruction itself
instead of the return address.

Change-Id: Icc4eb08320052975a4ae7f0f5f0ac9308a2d33d7
parent fe6c5948

debuggerd/arm/machine.c

+2 −2
Original line number Diff line number Diff line
@@ -87,7 +87,7 @@ static void dump_memory_and_code(int tfd, pid_t tid, bool at_fault) { 
    }

}



void dump_registers(ptrace_context_t* context __attribute((unused)),

void dump_registers(const ptrace_context_t* context __attribute((unused)),

        int tfd, pid_t tid, bool at_fault)

{

    struct pt_regs r;
@@ -125,7 +125,7 @@ void dump_registers(ptrace_context_t* context __attribute((unused)), 
#endif

}



void dump_thread(ptrace_context_t* context, int tfd, pid_t tid, bool at_fault) {

void dump_thread(const ptrace_context_t* context, int tfd, pid_t tid, bool at_fault) {

    dump_registers(context, tfd, tid, at_fault);



    dump_backtrace_and_stack(context, tfd, tid, at_fault);

debuggerd/debuggerd.c

+4 −4
Original line number Diff line number Diff line
@@ -114,12 +114,12 @@ static const char *get_sigcode(int signo, int code) 
    return "?";

}



static void dump_fault_addr(int tfd, pid_t pid, int sig)

static void dump_fault_addr(int tfd, pid_t tid, int sig)

{

    siginfo_t si;



    memset(&si, 0, sizeof(si));

    if(ptrace(PTRACE_GETSIGINFO, pid, 0, &si)){

    if(ptrace(PTRACE_GETSIGINFO, tid, 0, &si)){

        _LOG(tfd, false, "cannot get siginfo: %s\n", strerror(errno));

    } else if (signal_has_address(sig)) {

        _LOG(tfd, false, "signal %d (%s), code %d (%s), fault addr %08x\n",
@@ -157,7 +157,7 @@ static void dump_crash_banner(int tfd, pid_t pid, pid_t tid, int sig) 
}



/* Return true if some thread is not detached cleanly */

static bool dump_sibling_thread_report(ptrace_context_t* context,

static bool dump_sibling_thread_report(const ptrace_context_t* context,

        int tfd, pid_t pid, pid_t tid) {

    char task_path[64];

    snprintf(task_path, sizeof(task_path), "/proc/%d/task", pid);
@@ -361,7 +361,7 @@ static bool dump_crash(int tfd, pid_t pid, pid_t tid, int signal, 


    dump_crash_banner(tfd, pid, tid, signal);



    ptrace_context_t* context = load_ptrace_context(pid);

    ptrace_context_t* context = load_ptrace_context(tid);



    dump_thread(context, tfd, tid, true);

debuggerd/machine.h

+1 −1
Original line number Diff line number Diff line
@@ -20,6 +20,6 @@ 
#include <corkscrew/backtrace.h>

#include <sys/types.h>



void dump_thread(ptrace_context_t* context, int tfd, pid_t tid, bool at_fault);

void dump_thread(const ptrace_context_t* context, int tfd, pid_t tid, bool at_fault);



#endif // _DEBUGGERD_MACHINE_H

debuggerd/utility.c

+12 −11
Original line number Diff line number Diff line
@@ -57,8 +57,8 @@ bool signal_has_address(int sig) { 
    }

}



static void dump_backtrace(ptrace_context_t* context __attribute((unused)),

        int tfd, int pid __attribute((unused)), bool at_fault,

static void dump_backtrace(const ptrace_context_t* context __attribute((unused)),

        int tfd, pid_t tid __attribute((unused)), bool at_fault,

        const backtrace_frame_t* backtrace, size_t frames) {

    _LOG(tfd, !at_fault, "\nbacktrace:\n");
@@ -66,7 +66,7 @@ static void dump_backtrace(ptrace_context_t* context __attribute((unused)), 
    get_backtrace_symbols_ptrace(context, backtrace, frames, backtrace_symbols);

    for (size_t i = 0; i < frames; i++) {

        const backtrace_symbol_t* symbol = &backtrace_symbols[i];

        const char* map_name = symbol->map_info ? symbol->map_info->name : "<unknown>";

        const char* map_name = symbol->map_name ? symbol->map_name : "<unknown>";

        const char* symbol_name = symbol->demangled_name ? symbol->demangled_name : symbol->name;

        if (symbol_name) {

            _LOG(tfd, !at_fault, "    #%02d  pc %08x  %s (%s)\n",
@@ -79,11 +79,11 @@ static void dump_backtrace(ptrace_context_t* context __attribute((unused)), 
    free_backtrace_symbols(backtrace_symbols, frames);

}



static void dump_stack_segment(ptrace_context_t* context, int tfd, int pid,

static void dump_stack_segment(const ptrace_context_t* context, int tfd, pid_t tid,

        bool only_in_tombstone, uintptr_t* sp, size_t words, int label) {

    for (size_t i = 0; i < words; i++) {

        uint32_t stack_content;

        if (!try_get_word(pid, *sp, &stack_content)) {

        if (!try_get_word_ptrace(tid, *sp, &stack_content)) {

            break;

        }
@@ -116,7 +116,7 @@ static void dump_stack_segment(ptrace_context_t* context, int tfd, int pid, 
    }

}



static void dump_stack(ptrace_context_t* context, int tfd, int pid, bool at_fault,

static void dump_stack(const ptrace_context_t* context, int tfd, pid_t tid, bool at_fault,

        const backtrace_frame_t* backtrace, size_t frames) {

    bool have_first = false;

    size_t first, last;
@@ -138,7 +138,7 @@ static void dump_stack(ptrace_context_t* context, int tfd, int pid, bool at_faul 
    // Dump a few words before the first frame.

    bool only_in_tombstone = !at_fault;

    uintptr_t sp = backtrace[first].stack_top - STACK_WORDS * sizeof(uint32_t);

    dump_stack_segment(context, tfd, pid, only_in_tombstone, &sp, STACK_WORDS, -1);

    dump_stack_segment(context, tfd, tid, only_in_tombstone, &sp, STACK_WORDS, -1);



    // Dump a few words from all successive frames.

    // Only log the first 3 frames, put the rest in the tombstone.
@@ -152,7 +152,7 @@ static void dump_stack(ptrace_context_t* context, int tfd, int pid, bool at_faul 
            only_in_tombstone = true;

        }

        if (i == last) {

            dump_stack_segment(context, tfd, pid, only_in_tombstone, &sp, STACK_WORDS, i);

            dump_stack_segment(context, tfd, tid, only_in_tombstone, &sp, STACK_WORDS, i);

            if (sp < frame->stack_top + frame->stack_size) {

                _LOG(tfd, only_in_tombstone, "         ........  ........\n");

            }
@@ -163,12 +163,13 @@ static void dump_stack(ptrace_context_t* context, int tfd, int pid, bool at_faul 
            } else if (words > STACK_WORDS) {

                words = STACK_WORDS;

            }

            dump_stack_segment(context, tfd, pid, only_in_tombstone, &sp, words, i);

            dump_stack_segment(context, tfd, tid, only_in_tombstone, &sp, words, i);

        }

    }

}



void dump_backtrace_and_stack(ptrace_context_t* context, int tfd, pid_t tid, bool at_fault) {

void dump_backtrace_and_stack(const ptrace_context_t* context, int tfd, pid_t tid,

        bool at_fault) {

    backtrace_frame_t backtrace[STACK_DEPTH];

    ssize_t frames = unwind_backtrace_ptrace(tid, context, backtrace, 0, STACK_DEPTH);

    if (frames > 0) {
@@ -237,7 +238,7 @@ void dump_memory(int tfd, pid_t tid, uintptr_t addr, bool at_fault) { 
    }

}



void dump_nearby_maps(ptrace_context_t* context, int tfd, pid_t tid) {

void dump_nearby_maps(const ptrace_context_t* context, int tfd, pid_t tid) {

    siginfo_t si;

    memset(&si, 0, sizeof(si));

    if (ptrace(PTRACE_GETSIGINFO, tid, 0, &si)) {

debuggerd/utility.h

+2 −2
Original line number Diff line number Diff line
@@ -52,7 +52,7 @@ bool signal_has_address(int sig); 
/*

 * Dumps the backtrace and contents of the stack.

 */

void dump_backtrace_and_stack(ptrace_context_t* context, int tfd, pid_t pid, bool at_fault);

void dump_backtrace_and_stack(const ptrace_context_t* context, int tfd, pid_t tid, bool at_fault);



/*

 * Dumps a few bytes of memory, starting a bit before and ending a bit
@@ -66,7 +66,7 @@ void dump_memory(int tfd, pid_t tid, uintptr_t addr, bool at_fault); 
 *

 * This only makes sense to do on the thread that crashed.

 */

void dump_nearby_maps(ptrace_context_t* context, int tfd, pid_t tid);

void dump_nearby_maps(const ptrace_context_t* context, int tfd, pid_t tid);





#endif // _DEBUGGERD_UTILITY_H