Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2013 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 | #ifndef _BACKTRACE_H |
| 18 | #define _BACKTRACE_H |
| 19 | |
Christopher Ferris | e57912d | 2013-11-06 17:19:53 -0800 | [diff] [blame] | 20 | #include <stdint.h> |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 21 | #include <stdbool.h> |
Christopher Ferris | e57912d | 2013-11-06 17:19:53 -0800 | [diff] [blame] | 22 | #include <sys/types.h> |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 23 | |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 24 | __BEGIN_DECLS |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 25 | |
Christopher Ferris | cbfc730 | 2013-11-05 11:04:12 -0800 | [diff] [blame] | 26 | // When the pid to be traced is set to this value, then trace the current |
| 27 | // process. If the tid value is not BACKTRACE_NO_TID, then the specified |
| 28 | // thread from the current process will be traced. |
| 29 | #define BACKTRACE_CURRENT_PROCESS -1 |
| 30 | // When the tid to be traced is set to this value, then trace the specified |
| 31 | // pid. |
| 32 | #define BACKTRACE_NO_TID -1 |
| 33 | |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 34 | #define MAX_BACKTRACE_FRAMES 64 |
| 35 | |
| 36 | typedef struct backtrace_map_info { |
| 37 | struct backtrace_map_info* next; |
| 38 | uintptr_t start; |
| 39 | uintptr_t end; |
| 40 | bool is_readable; |
| 41 | bool is_writable; |
| 42 | bool is_executable; |
| 43 | char name[]; |
| 44 | } backtrace_map_info_t; |
| 45 | |
| 46 | typedef struct { |
| 47 | uintptr_t pc; /* The absolute pc. */ |
| 48 | uintptr_t sp; /* The top of the stack. */ |
| 49 | size_t stack_size; /* The size of the stack, zero indicate an unknown stack size. */ |
| 50 | const char* map_name; /* The name of the map to which this pc belongs, NULL indicates the pc doesn't belong to a known map. */ |
| 51 | uintptr_t map_offset; /* pc relative to the start of the map, only valid if map_name is not NULL. */ |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 52 | char* func_name; /* The function name associated with this pc, NULL if not found. */ |
| 53 | uintptr_t func_offset; /* pc relative to the start of the function, only valid if func_name is not NULL. */ |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 54 | } backtrace_frame_data_t; |
| 55 | |
| 56 | typedef struct { |
| 57 | backtrace_frame_data_t frames[MAX_BACKTRACE_FRAMES]; |
| 58 | size_t num_frames; |
| 59 | |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 60 | pid_t pid; |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 61 | pid_t tid; |
| 62 | backtrace_map_info_t* map_info_list; |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 63 | } backtrace_t; |
| 64 | |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 65 | typedef struct { |
| 66 | void* data; |
| 67 | const backtrace_t* backtrace; |
| 68 | } backtrace_context_t; |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 69 | |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 70 | /* Create a context for the backtrace data and gather the backtrace. |
| 71 | * If pid < 0, then gather the backtrace for the current process. |
| 72 | */ |
| 73 | bool backtrace_create_context( |
| 74 | backtrace_context_t* context, pid_t pid, pid_t tid, size_t num_ignore_frames); |
| 75 | |
Christopher Ferris | 9846497 | 2014-01-06 19:16:33 -0800 | [diff] [blame] | 76 | /* The same as backtrace_create_context, except that it is assumed that |
| 77 | * the pid map has already been acquired and the caller will handle freeing |
| 78 | * the map data. |
| 79 | */ |
| 80 | bool backtrace_create_context_with_map( |
| 81 | backtrace_context_t* context, pid_t pid, pid_t tid, size_t num_ignore_frames, |
| 82 | backtrace_map_info_t* map_info); |
| 83 | |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 84 | /* Gather the backtrace data for a pthread instead of a process. */ |
| 85 | bool backtrace_create_thread_context( |
| 86 | backtrace_context_t* context, pid_t tid, size_t num_ignore_frames); |
| 87 | |
| 88 | /* Free any memory allocated during the context create. */ |
| 89 | void backtrace_destroy_context(backtrace_context_t* context); |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 90 | |
| 91 | /* Read data at a specific address for a process. */ |
| 92 | bool backtrace_read_word( |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 93 | const backtrace_context_t* context, uintptr_t ptr, uint32_t* value); |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 94 | |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 95 | /* Get information about the map name associated with a pc. If NULL is |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 96 | * returned, then map_start is not set. |
| 97 | */ |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 98 | const char* backtrace_get_map_name( |
| 99 | const backtrace_context_t* context, uintptr_t pc, uintptr_t* map_start); |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 100 | |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 101 | /* Get the function name and offset given the pc. If NULL is returned, |
| 102 | * then func_offset is not set. The returned string is allocated using |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 103 | * malloc and must be freed by the caller. |
| 104 | */ |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 105 | char* backtrace_get_func_name( |
| 106 | const backtrace_context_t* context, uintptr_t pc, uintptr_t* func_offset); |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 107 | |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 108 | /* Loads memory map from /proc/<pid>/maps. If pid < 0, then load the memory |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 109 | * map for the current process. |
| 110 | */ |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 111 | backtrace_map_info_t* backtrace_create_map_info_list(pid_t pid); |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 112 | |
| 113 | /* Frees memory associated with the map list. */ |
| 114 | void backtrace_destroy_map_info_list(backtrace_map_info_t* map_info_list); |
| 115 | |
| 116 | /* Finds the memory map that contains the specified pc. */ |
| 117 | const backtrace_map_info_t* backtrace_find_map_info( |
| 118 | const backtrace_map_info_t* map_info_list, uintptr_t pc); |
| 119 | |
| 120 | /* Create a formatted line of backtrace information for a single frame. */ |
| 121 | void backtrace_format_frame_data( |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 122 | const backtrace_context_t* context, size_t frame_num, char* buf, |
| 123 | size_t buf_size); |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 124 | |
Christopher Ferris | 17e91d4 | 2013-10-21 13:30:52 -0700 | [diff] [blame] | 125 | /* Get the backtrace data structure associated with the context. */ |
| 126 | const backtrace_t* backtrace_get_data(backtrace_context_t* context); |
| 127 | |
| 128 | __END_DECLS |
Christopher Ferris | 7fb2287 | 2013-09-27 12:43:15 -0700 | [diff] [blame] | 129 | |
| 130 | #endif /* _BACKTRACE_H */ |