utility.h revision 136dcc5ce628a1ba600a6818e5cb24d5f15eb016
1/* system/debuggerd/utility.h
2**
3** Copyright 2008, 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#ifndef __utility_h
19#define __utility_h
20
21#include <stddef.h>
22#include <stdbool.h>
23
24#include "symbol_table.h"
25
26#ifndef PT_ARM_EXIDX
27#define PT_ARM_EXIDX    0x70000001      /* .ARM.exidx segment */
28#endif
29
30#define STACK_CONTENT_DEPTH 32
31
32typedef struct mapinfo {
33    struct mapinfo *next;
34    unsigned start;
35    unsigned end;
36    unsigned exidx_start;
37    unsigned exidx_end;
38    struct symbol_table *symbols;
39    bool isExecutable;
40    char name[];
41} mapinfo;
42
43/* Get a word from pid using ptrace. The result is the return value. */
44extern int get_remote_word(int pid, void *src);
45
46/* Handy routine to read aggregated data from pid using ptrace. The read
47 * values are written to the dest locations directly.
48 */
49extern void get_remote_struct(int pid, void *src, void *dst, size_t size);
50
51/* Find the containing map for the pc */
52const mapinfo *pc_to_mapinfo (mapinfo *mi, unsigned pc, unsigned *rel_pc);
53
54/* Map a pc address to the name of the containing ELF file */
55const char *map_to_name(mapinfo *mi, unsigned pc, const char* def);
56
57/* Log information onto the tombstone */
58extern void _LOG(int tfd, bool in_tombstone_only, const char *fmt, ...);
59
60/* Determine whether si_addr is valid for this signal */
61bool signal_has_address(int sig);
62
63#define LOG(fmt...) _LOG(-1, 0, fmt)
64
65/* Set to 1 for normal debug traces */
66#if 0
67#define XLOG(fmt...) _LOG(-1, 0, fmt)
68#else
69#define XLOG(fmt...) do {} while(0)
70#endif
71
72/* Set to 1 for chatty debug traces. Includes all resolved dynamic symbols */
73#if 0
74#define XLOG2(fmt...) _LOG(-1, 0, fmt)
75#else
76#define XLOG2(fmt...) do {} while(0)
77#endif
78
79#endif
80