1/* system/debuggerd/debuggerd.c
2**
3** Copyright 2006, The Android Open Source Project
4**
5** Licensed under the Apache License, Version 2.0 (the "License");
6** you may not use this file except in compliance with the License.
7** You may obtain a copy of the License at
8**
9**     http://www.apache.org/licenses/LICENSE-2.0
10**
11** Unless required by applicable law or agreed to in writing, software
12** distributed under the License is distributed on an "AS IS" BASIS,
13** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14** See the License for the specific language governing permissions and
15** limitations under the License.
16*/
17
18#include <stddef.h>
19#include <stdbool.h>
20#include <stdlib.h>
21#include <string.h>
22#include <stdio.h>
23#include <errno.h>
24#include <sys/types.h>
25#include <sys/ptrace.h>
26
27#include <corkscrew/ptrace.h>
28
29#include <linux/user.h>
30
31#include "../utility.h"
32#include "../machine.h"
33
34/* enable to dump memory pointed to by every register */
35#define DUMP_MEMORY_FOR_ALL_REGISTERS 1
36
37#ifdef WITH_VFP
38#ifdef WITH_VFP_D32
39#define NUM_VFP_REGS 32
40#else
41#define NUM_VFP_REGS 16
42#endif
43#endif
44
45static void dump_memory(log_t* log, pid_t tid, uintptr_t addr, int scopeFlags) {
46    char code_buffer[64];       /* actual 8+1+((8+1)*4) + 1 == 45 */
47    char ascii_buffer[32];      /* actual 16 + 1 == 17 */
48    uintptr_t p, end;
49
50    p = addr & ~3;
51    p -= 32;
52    if (p > addr) {
53        /* catch underflow */
54        p = 0;
55    }
56    /* Dump more memory content for the crashing thread. */
57    end = p + 256;
58    /* catch overflow; 'end - p' has to be multiples of 16 */
59    while (end < p)
60        end -= 16;
61
62    /* Dump the code around PC as:
63     *  addr     contents                             ascii
64     *  00008d34 ef000000 e8bd0090 e1b00000 512fff1e  ............../Q
65     *  00008d44 ea00b1f9 e92d0090 e3a070fc ef000000  ......-..p......
66     */
67    while (p < end) {
68        char* asc_out = ascii_buffer;
69
70        sprintf(code_buffer, "%08x ", p);
71
72        int i;
73        for (i = 0; i < 4; i++) {
74            /*
75             * If we see (data == -1 && errno != 0), we know that the ptrace
76             * call failed, probably because we're dumping memory in an
77             * unmapped or inaccessible page.  I don't know if there's
78             * value in making that explicit in the output -- it likely
79             * just complicates parsing and clarifies nothing for the
80             * enlightened reader.
81             */
82            long data = ptrace(PTRACE_PEEKTEXT, tid, (void*)p, NULL);
83            sprintf(code_buffer + strlen(code_buffer), "%08lx ", data);
84
85            /* Enable the following code blob to dump ASCII values */
86#if 0
87            int j;
88            for (j = 0; j < 4; j++) {
89                /*
90                 * Our isprint() allows high-ASCII characters that display
91                 * differently (often badly) in different viewers, so we
92                 * just use a simpler test.
93                 */
94                char val = (data >> (j*8)) & 0xff;
95                if (val >= 0x20 && val < 0x7f) {
96                    *asc_out++ = val;
97                } else {
98                    *asc_out++ = '.';
99                }
100            }
101#endif
102            p += 4;
103        }
104        *asc_out = '\0';
105        _LOG(log, scopeFlags, "    %s %s\n", code_buffer, ascii_buffer);
106    }
107}
108
109/*
110 * If configured to do so, dump memory around *all* registers
111 * for the crashing thread.
112 */
113void dump_memory_and_code(const ptrace_context_t* context __attribute((unused)),
114        log_t* log, pid_t tid, bool at_fault) {
115    struct pt_regs regs;
116    if(ptrace(PTRACE_GETREGS, tid, 0, &regs)) {
117        return;
118    }
119
120    int scopeFlags = at_fault ? SCOPE_AT_FAULT : 0;
121
122    if (at_fault && DUMP_MEMORY_FOR_ALL_REGISTERS) {
123        static const char REG_NAMES[] = "r0r1r2r3r4r5r6r7r8r9slfpipsp";
124
125        for (int reg = 0; reg < 14; reg++) {
126            /* this may not be a valid way to access, but it'll do for now */
127            uintptr_t addr = regs.uregs[reg];
128
129            /*
130             * Don't bother if it looks like a small int or ~= null, or if
131             * it's in the kernel area.
132             */
133            if (addr < 4096 || addr >= 0xc0000000) {
134                continue;
135            }
136
137            _LOG(log, scopeFlags | SCOPE_SENSITIVE, "\nmemory near %.2s:\n", &REG_NAMES[reg * 2]);
138            dump_memory(log, tid, addr, scopeFlags | SCOPE_SENSITIVE);
139        }
140    }
141
142    /* explicitly allow upload of code dump logging */
143    _LOG(log, scopeFlags, "\ncode around pc:\n");
144    dump_memory(log, tid, (uintptr_t)regs.ARM_pc, scopeFlags);
145
146    if (regs.ARM_pc != regs.ARM_lr) {
147        _LOG(log, scopeFlags, "\ncode around lr:\n");
148        dump_memory(log, tid, (uintptr_t)regs.ARM_lr, scopeFlags);
149    }
150}
151
152void dump_registers(const ptrace_context_t* context __attribute((unused)),
153        log_t* log, pid_t tid, bool at_fault)
154{
155    struct pt_regs r;
156    int scopeFlags = at_fault ? SCOPE_AT_FAULT : 0;
157
158    if(ptrace(PTRACE_GETREGS, tid, 0, &r)) {
159        _LOG(log, scopeFlags, "cannot get registers: %s\n", strerror(errno));
160        return;
161    }
162
163    _LOG(log, scopeFlags, "    r0 %08x  r1 %08x  r2 %08x  r3 %08x\n",
164            (uint32_t)r.ARM_r0, (uint32_t)r.ARM_r1, (uint32_t)r.ARM_r2, (uint32_t)r.ARM_r3);
165    _LOG(log, scopeFlags, "    r4 %08x  r5 %08x  r6 %08x  r7 %08x\n",
166            (uint32_t)r.ARM_r4, (uint32_t)r.ARM_r5, (uint32_t)r.ARM_r6, (uint32_t)r.ARM_r7);
167    _LOG(log, scopeFlags, "    r8 %08x  r9 %08x  sl %08x  fp %08x\n",
168            (uint32_t)r.ARM_r8, (uint32_t)r.ARM_r9, (uint32_t)r.ARM_r10, (uint32_t)r.ARM_fp);
169    _LOG(log, scopeFlags, "    ip %08x  sp %08x  lr %08x  pc %08x  cpsr %08x\n",
170            (uint32_t)r.ARM_ip, (uint32_t)r.ARM_sp, (uint32_t)r.ARM_lr,
171            (uint32_t)r.ARM_pc, (uint32_t)r.ARM_cpsr);
172
173#ifdef WITH_VFP
174    struct user_vfp vfp_regs;
175    int i;
176
177    if(ptrace(PTRACE_GETVFPREGS, tid, 0, &vfp_regs)) {
178        _LOG(log, scopeFlags, "cannot get registers: %s\n", strerror(errno));
179        return;
180    }
181
182    for (i = 0; i < NUM_VFP_REGS; i += 2) {
183        _LOG(log, scopeFlags, "    d%-2d %016llx  d%-2d %016llx\n",
184                i, vfp_regs.fpregs[i], i+1, vfp_regs.fpregs[i+1]);
185    }
186    _LOG(log, scopeFlags, "    scr %08lx\n", vfp_regs.fpscr);
187#endif
188}
189