DNBDefs.h revision 997b1e82f098a8b748b490d1ae6d0bbe597a59d5 
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//----------------------------------------------------------------------
31typedef 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
40typedef 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
50typedef uint64_t        nub_addr_t;
51#define INVALID_NUB_ADDRESS     ((nub_addr_t)~0ull)
52
53
54#endif
55
56typedef size_t          nub_size_t;
57typedef ssize_t         nub_ssize_t;
58typedef uint32_t        nub_break_t;
59typedef uint32_t        nub_watch_t;
60typedef uint32_t        nub_index_t;
61typedef pid_t           nub_process_t;
62typedef unsigned int    nub_thread_t;
63typedef uint32_t        nub_event_t;
64typedef 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_HW_INDEX    UINT32_MAX
70#define INVALID_NUB_REGNUM      UINT32_MAX
71#define NUB_GENERIC_ERROR       UINT32_MAX
72
73#define NUB_BREAK_ID_IS_VALID(breakID)    ((breakID) != (INVALID_NUB_BREAK_ID))
74
75// Watchpoint types
76#define WATCH_TYPE_READ     (1u << 0)
77#define WATCH_TYPE_WRITE    (1u << 1)
78
79typedef enum
80{
81    eStateInvalid = 0,
82    eStateUnloaded,
83    eStateAttaching,
84    eStateLaunching,
85    eStateStopped,
86    eStateRunning,
87    eStateStepping,
88    eStateCrashed,
89    eStateDetached,
90    eStateExited,
91    eStateSuspended
92} nub_state_t;
93
94typedef enum
95{
96    eLaunchFlavorDefault = 0,
97    eLaunchFlavorPosixSpawn,
98    eLaunchFlavorForkExec,
99#if defined (__arm__)
100    eLaunchFlavorSpringBoard,
101#endif
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
115enum
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    eEventProcessAsyncInterrupt = 1 << 4,               // Gives the ability for any infinite wait calls to be interrupted
122    kAllEventsMask = eEventProcessRunningStateChanged |
123                     eEventProcessStoppedStateChanged |
124                     eEventSharedLibsStateChange |
125                     eEventStdioAvailable |
126                     eEventProcessAsyncInterrupt
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
175enum DNBRegisterType
176{
177    InvalidRegType = 0,
178    Uint,               // unsigned integer
179    Sint,               // signed integer
180    IEEE754,            // float
181    Vector              // vector registers
182};
183
184enum 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
201struct 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};
216
217struct DNBRegisterSetInfo
218{
219    const char *name;                           // Name of this register set
220    const struct DNBRegisterInfo *registers;    // An array of register descriptions
221    nub_size_t num_registers;                   // The number of registers in REGISTERS array above
222};
223
224struct DNBThreadResumeAction
225{
226    nub_thread_t tid;   // The thread ID that this action applies to, INVALID_NUB_THREAD for the default thread action
227    nub_state_t state;  // Valid values are eStateStopped/eStateSuspended, eStateRunning, and eStateStepping.
228    int signal;         // When resuming this thread, resume it with this signal
229    nub_addr_t addr;    // If not INVALID_NUB_ADDRESS, then set the PC for the thread to ADDR before resuming/stepping
230};
231
232enum DNBThreadStopType
233{
234    eStopTypeInvalid = 0,
235    eStopTypeSignal,
236    eStopTypeException
237};
238
239enum DNBMemoryPermissions
240{
241    eMemoryPermissionsWritable    = (1 << 0),
242    eMemoryPermissionsReadable    = (1 << 1),
243    eMemoryPermissionsExecutable  = (1 << 2)
244};
245
246#define DNB_THREAD_STOP_INFO_MAX_DESC_LENGTH    256
247#define DNB_THREAD_STOP_INFO_MAX_EXC_DATA       8
248
249//----------------------------------------------------------------------
250// DNBThreadStopInfo
251//
252// Describes the reason a thread stopped.
253//----------------------------------------------------------------------
254struct DNBThreadStopInfo
255{
256    DNBThreadStopType reason;
257    char description[DNB_THREAD_STOP_INFO_MAX_DESC_LENGTH];
258    union
259    {
260        // eStopTypeSignal
261        struct
262        {
263            uint32_t signo;
264        } signal;
265
266        // eStopTypeException
267        struct
268        {
269            uint32_t type;
270            nub_size_t data_count;
271            nub_addr_t data[DNB_THREAD_STOP_INFO_MAX_EXC_DATA];
272        } exception;
273    } details;
274};
275
276
277struct DNBRegisterValue
278{
279    struct DNBRegisterInfo info;    // Register information for this register
280    union
281    {
282        int8_t      sint8;
283        int16_t     sint16;
284        int32_t     sint32;
285        int64_t     sint64;
286        uint8_t     uint8;
287        uint16_t    uint16;
288        uint32_t    uint32;
289        uint64_t    uint64;
290        float       float32;
291        double      float64;
292        int8_t      v_sint8[32];
293        int16_t     v_sint16[16];
294        int32_t     v_sint32[8];
295        int64_t     v_sint64[4];
296        uint8_t     v_uint8[32];
297        uint16_t    v_uint16[16];
298        uint32_t    v_uint32[8];
299        uint64_t    v_uint64[4];
300        float       v_float32[8];
301        double      v_float64[4];
302        void        *pointer;
303        char        *c_str;
304    } value;
305};
306
307enum DNBSharedLibraryState
308{
309    eShlibStateUnloaded    = 0,
310    eShlibStateLoaded    = 1
311};
312
313#ifndef DNB_MAX_SEGMENT_NAME_LENGTH
314#define DNB_MAX_SEGMENT_NAME_LENGTH    32
315#endif
316
317struct DNBSegment
318{
319    char        name[DNB_MAX_SEGMENT_NAME_LENGTH];
320    nub_addr_t  addr;
321    nub_addr_t  size;
322};
323
324struct DNBExecutableImageInfo
325{
326    char        name[PATH_MAX]; // Name of the executable image (usually a full path)
327    uint32_t    state;          // State of the executable image (see enum DNBSharedLibraryState)
328    nub_addr_t  header_addr;    // Executable header address
329    uuid_t      uuid;           // Unique indentifier for matching with symbols
330    uint32_t    num_segments;   // Number of contiguous memory segments to in SEGMENTS array
331    DNBSegment  *segments;      // Array of contiguous memory segments in executable
332};
333
334typedef nub_bool_t (*DNBCallbackBreakpointHit)(nub_process_t pid, nub_thread_t tid, nub_break_t breakID, void *baton);
335typedef nub_addr_t (*DNBCallbackNameToAddress)(nub_process_t pid, const char *name, const char *shlib_regex, void *baton);
336typedef nub_size_t (*DNBCallbackCopyExecutableImageInfos)(nub_process_t pid, struct DNBExecutableImageInfo **image_infos, nub_bool_t only_changed, void *baton);
337typedef void (*DNBCallbackLog)(void *baton, uint32_t flags, const char *format, va_list args);
338
339#endif    // #ifndef __DNBDefs_h__
340