1 //===-- DNBDefs.h -----------------------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // Created by Greg Clayton on 6/26/07. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #ifndef __DNBDefs_h__ 15 #define __DNBDefs_h__ 16 17 #include <stdint.h> 18 #include <signal.h> 19 #include <stdio.h> 20 #include <sys/syslimits.h> 21 #include <unistd.h> 22 23 //---------------------------------------------------------------------- 24 // Define nub_addr_t and the invalid address value from the architecture 25 //---------------------------------------------------------------------- 26 #if defined (__x86_64__) || defined (__ppc64__) 27 28 //---------------------------------------------------------------------- 29 // 64 bit address architectures 30 //---------------------------------------------------------------------- 31 typedef uint64_t nub_addr_t; 32 #define INVALID_NUB_ADDRESS ((nub_addr_t)~0ull) 33 34 #elif defined (__i386__) || defined (__powerpc__) || defined (__ppc__) || defined (__arm__) 35 36 //---------------------------------------------------------------------- 37 // 32 bit address architectures 38 //---------------------------------------------------------------------- 39 40 typedef uint32_t nub_addr_t; 41 #define INVALID_NUB_ADDRESS ((nub_addr_t)~0ul) 42 43 #else 44 45 //---------------------------------------------------------------------- 46 // Default to 64 bit address for unrecognized architectures. 47 //---------------------------------------------------------------------- 48 49 #warning undefined architecture, defaulting to 8 byte addresses 50 typedef uint64_t nub_addr_t; 51 #define INVALID_NUB_ADDRESS ((nub_addr_t)~0ull) 52 53 54 #endif 55 56 typedef size_t nub_size_t; 57 typedef ssize_t nub_ssize_t; 58 typedef uint32_t nub_break_t; 59 typedef uint32_t nub_watch_t; 60 typedef uint32_t nub_index_t; 61 typedef pid_t nub_process_t; 62 typedef unsigned int nub_thread_t; 63 typedef uint32_t nub_event_t; 64 typedef uint32_t nub_bool_t; 65 66 #define INVALID_NUB_BREAK_ID ((nub_break_t)0) 67 #define INVALID_NUB_PROCESS ((nub_process_t)0) 68 #define INVALID_NUB_THREAD ((nub_thread_t)0) 69 #define INVALID_NUB_WATCH_ID ((nub_watch_t)0) 70 #define INVALID_NUB_HW_INDEX UINT32_MAX 71 #define INVALID_NUB_REGNUM UINT32_MAX 72 #define NUB_GENERIC_ERROR UINT32_MAX 73 74 #define NUB_BREAK_ID_IS_VALID(breakID) ((breakID) != (INVALID_NUB_BREAK_ID)) 75 #define NUB_WATCH_ID_IS_VALID(watchID) ((watchID) != (INVALID_NUB_WATCH_ID)) 76 77 // Watchpoint types 78 #define WATCH_TYPE_READ (1u << 0) 79 #define WATCH_TYPE_WRITE (1u << 1) 80 81 typedef enum 82 { 83 eStateInvalid = 0, 84 eStateUnloaded, 85 eStateAttaching, 86 eStateLaunching, 87 eStateStopped, 88 eStateRunning, 89 eStateStepping, 90 eStateCrashed, 91 eStateDetached, 92 eStateExited, 93 eStateSuspended 94 } nub_state_t; 95 96 typedef enum 97 { 98 eLaunchFlavorDefault = 0, 99 eLaunchFlavorPosixSpawn, 100 eLaunchFlavorForkExec, 101 #if defined (__arm__) 102 eLaunchFlavorSpringBoard, 103 #endif 104 } nub_launch_flavor_t; 105 106 #define NUB_STATE_IS_RUNNING(s) ((s) == eStateAttaching ||\ 107 (s) == eStateLaunching ||\ 108 (s) == eStateRunning ||\ 109 (s) == eStateStepping ||\ 110 (s) == eStateDetached) 111 112 #define NUB_STATE_IS_STOPPED(s) ((s) == eStateUnloaded ||\ 113 (s) == eStateStopped ||\ 114 (s) == eStateCrashed ||\ 115 (s) == eStateExited) 116 117 enum 118 { 119 eEventProcessRunningStateChanged = 1 << 0, // The process has changed state to running 120 eEventProcessStoppedStateChanged = 1 << 1, // The process has changed state to stopped 121 eEventSharedLibsStateChange = 1 << 2, // Shared libraries loaded/unloaded state has changed 122 eEventStdioAvailable = 1 << 3, // Something is available on stdout/stderr 123 eEventProcessAsyncInterrupt = 1 << 4, // Gives the ability for any infinite wait calls to be interrupted 124 kAllEventsMask = eEventProcessRunningStateChanged | 125 eEventProcessStoppedStateChanged | 126 eEventSharedLibsStateChange | 127 eEventStdioAvailable | 128 eEventProcessAsyncInterrupt 129 }; 130 131 #define LOG_VERBOSE (1u << 0) 132 #define LOG_PROCESS (1u << 1) 133 #define LOG_THREAD (1u << 2) 134 #define LOG_EXCEPTIONS (1u << 3) 135 #define LOG_SHLIB (1u << 4) 136 #define LOG_MEMORY (1u << 5) // Log memory reads/writes calls 137 #define LOG_MEMORY_DATA_SHORT (1u << 6) // Log short memory reads/writes bytes 138 #define LOG_MEMORY_DATA_LONG (1u << 7) // Log all memory reads/writes bytes 139 #define LOG_MEMORY_PROTECTIONS (1u << 8) // Log memory protection changes 140 #define LOG_BREAKPOINTS (1u << 9) 141 #define LOG_EVENTS (1u << 10) 142 #define LOG_WATCHPOINTS (1u << 11) 143 #define LOG_STEP (1u << 12) 144 #define LOG_TASK (1u << 13) 145 #define LOG_LO_USER (1u << 16) 146 #define LOG_HI_USER (1u << 31) 147 #define LOG_ALL 0xFFFFFFFFu 148 #define LOG_DEFAULT ((LOG_PROCESS) |\ 149 (LOG_TASK) |\ 150 (LOG_THREAD) |\ 151 (LOG_EXCEPTIONS) |\ 152 (LOG_SHLIB) |\ 153 (LOG_MEMORY) |\ 154 (LOG_BREAKPOINTS) |\ 155 (LOG_WATCHPOINTS) |\ 156 (LOG_STEP)) 157 158 159 #define REGISTER_SET_ALL 0 160 // Generic Register set to be defined by each architecture for access to common 161 // register values. 162 #define REGISTER_SET_GENERIC ((uint32_t)0xFFFFFFFFu) 163 #define GENERIC_REGNUM_PC 0 // Program Counter 164 #define GENERIC_REGNUM_SP 1 // Stack Pointer 165 #define GENERIC_REGNUM_FP 2 // Frame Pointer 166 #define GENERIC_REGNUM_RA 3 // Return Address 167 #define GENERIC_REGNUM_FLAGS 4 // Processor flags register 168 #define GENERIC_REGNUM_ARG1 5 // The register that would contain pointer size or less argument 1 (if any) 169 #define GENERIC_REGNUM_ARG2 6 // The register that would contain pointer size or less argument 2 (if any) 170 #define GENERIC_REGNUM_ARG3 7 // The register that would contain pointer size or less argument 3 (if any) 171 #define GENERIC_REGNUM_ARG4 8 // The register that would contain pointer size or less argument 4 (if any) 172 #define GENERIC_REGNUM_ARG5 9 // The register that would contain pointer size or less argument 5 (if any) 173 #define GENERIC_REGNUM_ARG6 10 // The register that would contain pointer size or less argument 6 (if any) 174 #define GENERIC_REGNUM_ARG7 11 // The register that would contain pointer size or less argument 7 (if any) 175 #define GENERIC_REGNUM_ARG8 12 // The register that would contain pointer size or less argument 8 (if any) 176 177 enum DNBRegisterType 178 { 179 InvalidRegType = 0, 180 Uint, // unsigned integer 181 Sint, // signed integer 182 IEEE754, // float 183 Vector // vector registers 184 }; 185 186 enum DNBRegisterFormat 187 { 188 InvalidRegFormat = 0, 189 Binary, 190 Decimal, 191 Hex, 192 Float, 193 VectorOfSInt8, 194 VectorOfUInt8, 195 VectorOfSInt16, 196 VectorOfUInt16, 197 VectorOfSInt32, 198 VectorOfUInt32, 199 VectorOfFloat32, 200 VectorOfUInt128 201 }; 202 203 struct DNBRegisterInfo 204 { 205 uint32_t set; // Register set 206 uint32_t reg; // Register number 207 const char *name; // Name of this register 208 const char *alt; // Alternate name 209 uint16_t type; // Type of the register bits (DNBRegisterType) 210 uint16_t format; // Default format for display (DNBRegisterFormat), 211 uint32_t size; // Size in bytes of the register 212 uint32_t offset; // Offset from the beginning of the register context 213 uint32_t reg_gcc; // GCC register number (INVALID_NUB_REGNUM when none) 214 uint32_t reg_dwarf; // DWARF register number (INVALID_NUB_REGNUM when none) 215 uint32_t reg_generic; // Generic register number (INVALID_NUB_REGNUM when none) 216 uint32_t reg_gdb; // The GDB register number (INVALID_NUB_REGNUM when none) 217 }; 218 219 struct DNBRegisterSetInfo 220 { 221 const char *name; // Name of this register set 222 const struct DNBRegisterInfo *registers; // An array of register descriptions 223 nub_size_t num_registers; // The number of registers in REGISTERS array above 224 }; 225 226 struct DNBThreadResumeAction 227 { 228 nub_thread_t tid; // The thread ID that this action applies to, INVALID_NUB_THREAD for the default thread action 229 nub_state_t state; // Valid values are eStateStopped/eStateSuspended, eStateRunning, and eStateStepping. 230 int signal; // When resuming this thread, resume it with this signal 231 nub_addr_t addr; // If not INVALID_NUB_ADDRESS, then set the PC for the thread to ADDR before resuming/stepping 232 }; 233 234 enum DNBThreadStopType 235 { 236 eStopTypeInvalid = 0, 237 eStopTypeSignal, 238 eStopTypeException 239 }; 240 241 enum DNBMemoryPermissions 242 { 243 eMemoryPermissionsWritable = (1 << 0), 244 eMemoryPermissionsReadable = (1 << 1), 245 eMemoryPermissionsExecutable = (1 << 2) 246 }; 247 248 #define DNB_THREAD_STOP_INFO_MAX_DESC_LENGTH 256 249 #define DNB_THREAD_STOP_INFO_MAX_EXC_DATA 8 250 251 //---------------------------------------------------------------------- 252 // DNBThreadStopInfo 253 // 254 // Describes the reason a thread stopped. 255 //---------------------------------------------------------------------- 256 struct DNBThreadStopInfo 257 { 258 DNBThreadStopType reason; 259 char description[DNB_THREAD_STOP_INFO_MAX_DESC_LENGTH]; 260 union 261 { 262 // eStopTypeSignal 263 struct 264 { 265 uint32_t signo; 266 } signal; 267 268 // eStopTypeException 269 struct 270 { 271 uint32_t type; 272 nub_size_t data_count; 273 nub_addr_t data[DNB_THREAD_STOP_INFO_MAX_EXC_DATA]; 274 } exception; 275 } details; 276 }; 277 278 279 struct DNBRegisterValue 280 { 281 struct DNBRegisterInfo info; // Register information for this register 282 union 283 { 284 int8_t sint8; 285 int16_t sint16; 286 int32_t sint32; 287 int64_t sint64; 288 uint8_t uint8; 289 uint16_t uint16; 290 uint32_t uint32; 291 uint64_t uint64; 292 float float32; 293 double float64; 294 int8_t v_sint8[32]; 295 int16_t v_sint16[16]; 296 int32_t v_sint32[8]; 297 int64_t v_sint64[4]; 298 uint8_t v_uint8[32]; 299 uint16_t v_uint16[16]; 300 uint32_t v_uint32[8]; 301 uint64_t v_uint64[4]; 302 float v_float32[8]; 303 double v_float64[4]; 304 void *pointer; 305 char *c_str; 306 } value; 307 }; 308 309 enum DNBSharedLibraryState 310 { 311 eShlibStateUnloaded = 0, 312 eShlibStateLoaded = 1 313 }; 314 315 #ifndef DNB_MAX_SEGMENT_NAME_LENGTH 316 #define DNB_MAX_SEGMENT_NAME_LENGTH 32 317 #endif 318 319 struct DNBSegment 320 { 321 char name[DNB_MAX_SEGMENT_NAME_LENGTH]; 322 nub_addr_t addr; 323 nub_addr_t size; 324 }; 325 326 struct DNBExecutableImageInfo 327 { 328 char name[PATH_MAX]; // Name of the executable image (usually a full path) 329 uint32_t state; // State of the executable image (see enum DNBSharedLibraryState) 330 nub_addr_t header_addr; // Executable header address 331 uuid_t uuid; // Unique indentifier for matching with symbols 332 uint32_t num_segments; // Number of contiguous memory segments to in SEGMENTS array 333 DNBSegment *segments; // Array of contiguous memory segments in executable 334 }; 335 336 struct DNBRegionInfo 337 { 338 nub_addr_t addr; 339 nub_addr_t size; 340 uint32_t permissions; 341 }; 342 343 typedef nub_bool_t (*DNBCallbackBreakpointHit)(nub_process_t pid, nub_thread_t tid, nub_break_t breakID, void *baton); 344 typedef nub_addr_t (*DNBCallbackNameToAddress)(nub_process_t pid, const char *name, const char *shlib_regex, void *baton); 345 typedef nub_size_t (*DNBCallbackCopyExecutableImageInfos)(nub_process_t pid, struct DNBExecutableImageInfo **image_infos, nub_bool_t only_changed, void *baton); 346 typedef void (*DNBCallbackLog)(void *baton, uint32_t flags, const char *format, va_list args); 347 348 #endif // #ifndef __DNBDefs_h__ 349