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__) || defined (__arm64__) || defined (__aarch64__) 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_index_t; 59 typedef pid_t nub_process_t; 60 typedef uint64_t nub_thread_t; 61 typedef uint32_t nub_event_t; 62 typedef uint32_t nub_bool_t; 63 64 #define INVALID_NUB_PROCESS ((nub_process_t)0) 65 #define INVALID_NUB_THREAD ((nub_thread_t)0) 66 #define INVALID_NUB_WATCH_ID ((nub_watch_t)0) 67 #define INVALID_NUB_HW_INDEX UINT32_MAX 68 #define INVALID_NUB_REGNUM UINT32_MAX 69 #define NUB_GENERIC_ERROR UINT32_MAX 70 71 // Watchpoint types 72 #define WATCH_TYPE_READ (1u << 0) 73 #define WATCH_TYPE_WRITE (1u << 1) 74 75 typedef enum 76 { 77 eStateInvalid = 0, 78 eStateUnloaded, 79 eStateAttaching, 80 eStateLaunching, 81 eStateStopped, 82 eStateRunning, 83 eStateStepping, 84 eStateCrashed, 85 eStateDetached, 86 eStateExited, 87 eStateSuspended 88 } nub_state_t; 89 90 typedef enum 91 { 92 eLaunchFlavorDefault = 0, 93 eLaunchFlavorPosixSpawn = 1, 94 eLaunchFlavorForkExec = 2, 95 #ifdef WITH_SPRINGBOARD 96 eLaunchFlavorSpringBoard = 3, 97 #endif 98 #ifdef WITH_BKS 99 eLaunchFlavorBKS = 4 100 #endif 101 102 } nub_launch_flavor_t; 103 104 #define NUB_STATE_IS_RUNNING(s) ((s) == eStateAttaching ||\ 105 (s) == eStateLaunching ||\ 106 (s) == eStateRunning ||\ 107 (s) == eStateStepping ||\ 108 (s) == eStateDetached) 109 110 #define NUB_STATE_IS_STOPPED(s) ((s) == eStateUnloaded ||\ 111 (s) == eStateStopped ||\ 112 (s) == eStateCrashed ||\ 113 (s) == eStateExited) 114 115 enum 116 { 117 eEventProcessRunningStateChanged = 1 << 0, // The process has changed state to running 118 eEventProcessStoppedStateChanged = 1 << 1, // The process has changed state to stopped 119 eEventSharedLibsStateChange = 1 << 2, // Shared libraries loaded/unloaded state has changed 120 eEventStdioAvailable = 1 << 3, // Something is available on stdout/stderr 121 eEventProfileDataAvailable = 1 << 4, // Profile data ready for retrieval 122 kAllEventsMask = eEventProcessRunningStateChanged | 123 eEventProcessStoppedStateChanged | 124 eEventSharedLibsStateChange | 125 eEventStdioAvailable | 126 eEventProfileDataAvailable 127 }; 128 129 #define LOG_VERBOSE (1u << 0) 130 #define LOG_PROCESS (1u << 1) 131 #define LOG_THREAD (1u << 2) 132 #define LOG_EXCEPTIONS (1u << 3) 133 #define LOG_SHLIB (1u << 4) 134 #define LOG_MEMORY (1u << 5) // Log memory reads/writes calls 135 #define LOG_MEMORY_DATA_SHORT (1u << 6) // Log short memory reads/writes bytes 136 #define LOG_MEMORY_DATA_LONG (1u << 7) // Log all memory reads/writes bytes 137 #define LOG_MEMORY_PROTECTIONS (1u << 8) // Log memory protection changes 138 #define LOG_BREAKPOINTS (1u << 9) 139 #define LOG_EVENTS (1u << 10) 140 #define LOG_WATCHPOINTS (1u << 11) 141 #define LOG_STEP (1u << 12) 142 #define LOG_TASK (1u << 13) 143 #define LOG_LO_USER (1u << 16) 144 #define LOG_HI_USER (1u << 31) 145 #define LOG_ALL 0xFFFFFFFFu 146 #define LOG_DEFAULT ((LOG_PROCESS) |\ 147 (LOG_TASK) |\ 148 (LOG_THREAD) |\ 149 (LOG_EXCEPTIONS) |\ 150 (LOG_SHLIB) |\ 151 (LOG_MEMORY) |\ 152 (LOG_BREAKPOINTS) |\ 153 (LOG_WATCHPOINTS) |\ 154 (LOG_STEP)) 155 156 157 #define REGISTER_SET_ALL 0 158 // Generic Register set to be defined by each architecture for access to common 159 // register values. 160 #define REGISTER_SET_GENERIC ((uint32_t)0xFFFFFFFFu) 161 #define GENERIC_REGNUM_PC 0 // Program Counter 162 #define GENERIC_REGNUM_SP 1 // Stack Pointer 163 #define GENERIC_REGNUM_FP 2 // Frame Pointer 164 #define GENERIC_REGNUM_RA 3 // Return Address 165 #define GENERIC_REGNUM_FLAGS 4 // Processor flags register 166 #define GENERIC_REGNUM_ARG1 5 // The register that would contain pointer size or less argument 1 (if any) 167 #define GENERIC_REGNUM_ARG2 6 // The register that would contain pointer size or less argument 2 (if any) 168 #define GENERIC_REGNUM_ARG3 7 // The register that would contain pointer size or less argument 3 (if any) 169 #define GENERIC_REGNUM_ARG4 8 // The register that would contain pointer size or less argument 4 (if any) 170 #define GENERIC_REGNUM_ARG5 9 // The register that would contain pointer size or less argument 5 (if any) 171 #define GENERIC_REGNUM_ARG6 10 // The register that would contain pointer size or less argument 6 (if any) 172 #define GENERIC_REGNUM_ARG7 11 // The register that would contain pointer size or less argument 7 (if any) 173 #define GENERIC_REGNUM_ARG8 12 // The register that would contain pointer size or less argument 8 (if any) 174 175 enum DNBRegisterType 176 { 177 InvalidRegType = 0, 178 Uint, // unsigned integer 179 Sint, // signed integer 180 IEEE754, // float 181 Vector // vector registers 182 }; 183 184 enum DNBRegisterFormat 185 { 186 InvalidRegFormat = 0, 187 Binary, 188 Decimal, 189 Hex, 190 Float, 191 VectorOfSInt8, 192 VectorOfUInt8, 193 VectorOfSInt16, 194 VectorOfUInt16, 195 VectorOfSInt32, 196 VectorOfUInt32, 197 VectorOfFloat32, 198 VectorOfUInt128 199 }; 200 201 struct DNBRegisterInfo 202 { 203 uint32_t set; // Register set 204 uint32_t reg; // Register number 205 const char *name; // Name of this register 206 const char *alt; // Alternate name 207 uint16_t type; // Type of the register bits (DNBRegisterType) 208 uint16_t format; // Default format for display (DNBRegisterFormat), 209 uint32_t size; // Size in bytes of the register 210 uint32_t offset; // Offset from the beginning of the register context 211 uint32_t reg_gcc; // GCC register number (INVALID_NUB_REGNUM when none) 212 uint32_t reg_dwarf; // DWARF register number (INVALID_NUB_REGNUM when none) 213 uint32_t reg_generic; // Generic register number (INVALID_NUB_REGNUM when none) 214 uint32_t reg_gdb; // The GDB register number (INVALID_NUB_REGNUM when none) 215 const char **value_regs; // If this register is a part of other registers, list the register names terminated by NULL 216 const char **update_regs; // If modifying this register will invalidate other registers, list the register names terminated by NULL 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 eStopTypeExec 240 }; 241 242 enum DNBMemoryPermissions 243 { 244 eMemoryPermissionsWritable = (1 << 0), 245 eMemoryPermissionsReadable = (1 << 1), 246 eMemoryPermissionsExecutable = (1 << 2) 247 }; 248 249 #define DNB_THREAD_STOP_INFO_MAX_DESC_LENGTH 256 250 #define DNB_THREAD_STOP_INFO_MAX_EXC_DATA 8 251 252 //---------------------------------------------------------------------- 253 // DNBThreadStopInfo 254 // 255 // Describes the reason a thread stopped. 256 //---------------------------------------------------------------------- 257 struct DNBThreadStopInfo 258 { 259 DNBThreadStopType reason; 260 char description[DNB_THREAD_STOP_INFO_MAX_DESC_LENGTH]; 261 union 262 { 263 // eStopTypeSignal 264 struct 265 { 266 uint32_t signo; 267 } signal; 268 269 // eStopTypeException 270 struct 271 { 272 uint32_t type; 273 nub_size_t data_count; 274 nub_addr_t data[DNB_THREAD_STOP_INFO_MAX_EXC_DATA]; 275 } exception; 276 } details; 277 }; 278 279 280 struct DNBRegisterValue 281 { 282 struct DNBRegisterInfo info; // Register information for this register 283 union 284 { 285 int8_t sint8; 286 int16_t sint16; 287 int32_t sint32; 288 int64_t sint64; 289 uint8_t uint8; 290 uint16_t uint16; 291 uint32_t uint32; 292 uint64_t uint64; 293 float float32; 294 double float64; 295 int8_t v_sint8[32]; 296 int16_t v_sint16[16]; 297 int32_t v_sint32[8]; 298 int64_t v_sint64[4]; 299 uint8_t v_uint8[32]; 300 uint16_t v_uint16[16]; 301 uint32_t v_uint32[8]; 302 uint64_t v_uint64[4]; 303 float v_float32[8]; 304 double v_float64[4]; 305 void *pointer; 306 char *c_str; 307 } value; 308 }; 309 310 enum DNBSharedLibraryState 311 { 312 eShlibStateUnloaded = 0, 313 eShlibStateLoaded = 1 314 }; 315 316 #ifndef DNB_MAX_SEGMENT_NAME_LENGTH 317 #define DNB_MAX_SEGMENT_NAME_LENGTH 32 318 #endif 319 320 struct DNBSegment 321 { 322 char name[DNB_MAX_SEGMENT_NAME_LENGTH]; 323 nub_addr_t addr; 324 nub_addr_t size; 325 }; 326 327 struct DNBExecutableImageInfo 328 { 329 char name[PATH_MAX]; // Name of the executable image (usually a full path) 330 uint32_t state; // State of the executable image (see enum DNBSharedLibraryState) 331 nub_addr_t header_addr; // Executable header address 332 uuid_t uuid; // Unique indentifier for matching with symbols 333 uint32_t num_segments; // Number of contiguous memory segments to in SEGMENTS array 334 DNBSegment *segments; // Array of contiguous memory segments in executable 335 }; 336 337 struct DNBRegionInfo 338 { 339 nub_addr_t addr; 340 nub_addr_t size; 341 uint32_t permissions; 342 }; 343 344 enum DNBProfileDataScanType 345 { 346 eProfileHostCPU = (1 << 0), 347 eProfileCPU = (1 << 1), 348 349 eProfileThreadsCPU = (1 << 2), // By default excludes eProfileThreadName and eProfileQueueName. 350 eProfileThreadName = (1 << 3), // Assume eProfileThreadsCPU, get thread name as well. 351 eProfileQueueName = (1 << 4), // Assume eProfileThreadsCPU, get queue name as well. 352 353 eProfileHostMemory = (1 << 5), 354 355 eProfileMemory = (1 << 6), // By default, excludes eProfileMemoryDirtyPage. 356 eProfileMemoryDirtyPage = (1 << 7), // Assume eProfileMemory, get Dirty Page size as well. 357 eProfileMemoryAnonymous = (1 << 8), // Assume eProfileMemory, get Anonymous memory as well. 358 359 eProfileEnergy = (1 << 9), 360 361 eProfileAll = 0xffffffff 362 }; 363 364 typedef nub_addr_t (*DNBCallbackNameToAddress)(nub_process_t pid, const char *name, const char *shlib_regex, void *baton); 365 typedef nub_size_t (*DNBCallbackCopyExecutableImageInfos)(nub_process_t pid, struct DNBExecutableImageInfo **image_infos, nub_bool_t only_changed, void *baton); 366 typedef void (*DNBCallbackLog)(void *baton, uint32_t flags, const char *format, va_list args); 367 368 #endif // #ifndef __DNBDefs_h__ 369