blob: 921bbbfc23d09429e2483c2022102dbc1ecbf50e [file] [log] [blame]
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001//===-- DNB.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 3/23/07.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef __DNB_h__
15#define __DNB_h__
16
17#include "DNBDefs.h"
18#include <mach/thread_info.h>
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
24#define DNB_EXPORT __attribute__((visibility("default")))
25
26typedef bool (*DNBShouldCancelCallback) (void *);
27
Greg Clayton3af9ea52010-11-18 05:57:03 +000028void DNBInitialize ();
29void DNBTerminate ();
30
Chris Lattner30fdc8d2010-06-08 16:52:24 +000031//----------------------------------------------------------------------
32// Process control
33//----------------------------------------------------------------------
Greg Claytonf681b942010-08-31 18:35:14 +000034nub_process_t DNBProcessLaunch (const char *path, char const *argv[], const char *envp[], const char *stdio_path, nub_launch_flavor_t launch_flavor, int disable_aslr, char *err_str, size_t err_len) DNB_EXPORT;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000035nub_process_t DNBProcessAttach (nub_process_t pid, struct timespec *timeout, char *err_str, size_t err_len) DNB_EXPORT;
36nub_process_t DNBProcessAttachByName (const char *name, struct timespec *timeout, char *err_str, size_t err_len) DNB_EXPORT;
37nub_process_t DNBProcessAttachWait (const char *wait_name, nub_launch_flavor_t launch_flavor, struct timespec *timeout, useconds_t interval, char *err_str, size_t err_len, DNBShouldCancelCallback should_cancel = NULL, void *callback_data = NULL) DNB_EXPORT;
38// Resume a process with exact instructions on what to do with each thread:
39// - If no thread actions are supplied (actions is NULL or num_actions is zero),
40// then all threads are continued.
41// - If any thread actions are supplied, then each thread will do as it is told
42// by the action. A default actions for any threads that don't have an
43// explicit thread action can be made by making a thread action with a tid of
44// INVALID_NUB_THREAD. If there is no default action, those threads will
45// remain stopped.
46nub_bool_t DNBProcessResume (nub_process_t pid, const DNBThreadResumeAction *actions, size_t num_actions) DNB_EXPORT;
47nub_bool_t DNBProcessHalt (nub_process_t pid) DNB_EXPORT;
48nub_bool_t DNBProcessDetach (nub_process_t pid) DNB_EXPORT;
49nub_bool_t DNBProcessSignal (nub_process_t pid, int signal) DNB_EXPORT;
50nub_bool_t DNBProcessKill (nub_process_t pid) DNB_EXPORT;
51nub_size_t DNBProcessMemoryRead (nub_process_t pid, nub_addr_t addr, nub_size_t size, void *buf) DNB_EXPORT;
52nub_size_t DNBProcessMemoryWrite (nub_process_t pid, nub_addr_t addr, nub_size_t size, const void *buf) DNB_EXPORT;
53nub_addr_t DNBProcessMemoryAllocate (nub_process_t pid, nub_size_t size, uint32_t permissions) DNB_EXPORT;
54nub_bool_t DNBProcessMemoryDeallocate (nub_process_t pid, nub_addr_t addr) DNB_EXPORT;
55//----------------------------------------------------------------------
56// Process status
57//----------------------------------------------------------------------
58nub_bool_t DNBProcessIsAlive (nub_process_t pid) DNB_EXPORT;
59nub_state_t DNBProcessGetState (nub_process_t pid) DNB_EXPORT;
60nub_bool_t DNBProcessGetExitStatus (nub_process_t pid, int *status) DNB_EXPORT;
61nub_bool_t DNBProcessSetExitStatus (nub_process_t pid, int status) DNB_EXPORT;
62nub_size_t DNBProcessGetNumThreads (nub_process_t pid) DNB_EXPORT;
63nub_thread_t DNBProcessGetCurrentThread (nub_process_t pid) DNB_EXPORT;
64nub_thread_t DNBProcessSetCurrentThread (nub_process_t pid, nub_thread_t tid) DNB_EXPORT;
65nub_thread_t DNBProcessGetThreadAtIndex (nub_process_t pid, nub_size_t thread_idx) DNB_EXPORT;
66nub_addr_t DNBProcessGetSharedLibraryInfoAddress (nub_process_t pid) DNB_EXPORT;
67nub_bool_t DNBProcessSharedLibrariesUpdated (nub_process_t pid) DNB_EXPORT;
68nub_size_t DNBProcessGetSharedLibraryInfo (nub_process_t pid, nub_bool_t only_changed, DNBExecutableImageInfo **image_infos) DNB_EXPORT;
69nub_bool_t DNBProcessSetNameToAddressCallback (nub_process_t pid, DNBCallbackNameToAddress callback, void *baton) DNB_EXPORT;
70nub_bool_t DNBProcessSetSharedLibraryInfoCallback (nub_process_t pid, DNBCallbackCopyExecutableImageInfos callback, void *baton) DNB_EXPORT;
71nub_addr_t DNBProcessLookupAddress (nub_process_t pid, const char *name, const char *shlib) DNB_EXPORT;
72nub_size_t DNBProcessGetAvailableSTDOUT (nub_process_t pid, char *buf, nub_size_t buf_size) DNB_EXPORT;
73nub_size_t DNBProcessGetAvailableSTDERR (nub_process_t pid, char *buf, nub_size_t buf_size) DNB_EXPORT;
74nub_size_t DNBProcessGetStopCount (nub_process_t pid) DNB_EXPORT;
75//----------------------------------------------------------------------
76// Process executable and arguments
77//----------------------------------------------------------------------
78const char * DNBProcessGetExecutablePath (nub_process_t pid) DNB_EXPORT;
79const char * DNBProcessGetArgumentAtIndex (nub_process_t pid, nub_size_t idx) DNB_EXPORT;
80nub_size_t DNBProcessGetArgumentCount (nub_process_t pid) DNB_EXPORT;
81
82//----------------------------------------------------------------------
83// Process events
84//----------------------------------------------------------------------
85nub_event_t DNBProcessWaitForEvents (nub_process_t pid, nub_event_t event_mask, bool wait_for_set, struct timespec* timeout) DNB_EXPORT;
86void DNBProcessResetEvents (nub_process_t pid, nub_event_t event_mask) DNB_EXPORT;
87void DNBProcessInterruptEvents (nub_process_t pid) DNB_EXPORT;
88
89//----------------------------------------------------------------------
90// Thread functions
91//----------------------------------------------------------------------
92const char * DNBThreadGetName (nub_process_t pid, nub_thread_t tid) DNB_EXPORT;
93nub_bool_t DNBThreadGetIdentifierInfo (nub_process_t pid, nub_thread_t tid, thread_identifier_info_data_t *ident_info) DNB_EXPORT;
94nub_state_t DNBThreadGetState (nub_process_t pid, nub_thread_t tid) DNB_EXPORT;
95nub_bool_t DNBThreadGetRegisterValueByID (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, DNBRegisterValue *value) DNB_EXPORT;
96nub_bool_t DNBThreadSetRegisterValueByID (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, const DNBRegisterValue *value) DNB_EXPORT;
97nub_size_t DNBThreadGetRegisterContext (nub_process_t pid, nub_thread_t tid, void *buf, size_t buf_len) DNB_EXPORT;
98nub_size_t DNBThreadSetRegisterContext (nub_process_t pid, nub_thread_t tid, const void *buf, size_t buf_len) DNB_EXPORT;
99nub_bool_t DNBThreadGetRegisterValueByName (nub_process_t pid, nub_thread_t tid, uint32_t set, const char *name, DNBRegisterValue *value) DNB_EXPORT;
100nub_bool_t DNBThreadGetStopReason (nub_process_t pid, nub_thread_t tid, DNBThreadStopInfo *stop_info) DNB_EXPORT;
101const char * DNBThreadGetInfo (nub_process_t pid, nub_thread_t tid) DNB_EXPORT;
102//----------------------------------------------------------------------
103// Breakpoint functions
104//----------------------------------------------------------------------
105nub_break_t DNBBreakpointSet (nub_process_t pid, nub_addr_t addr, nub_size_t size, nub_bool_t hardware) DNB_EXPORT;
106nub_bool_t DNBBreakpointClear (nub_process_t pid, nub_break_t breakID) DNB_EXPORT;
107nub_ssize_t DNBBreakpointGetHitCount (nub_process_t pid, nub_break_t breakID) DNB_EXPORT;
108nub_ssize_t DNBBreakpointGetIgnoreCount (nub_process_t pid, nub_break_t breakID) DNB_EXPORT;
109nub_bool_t DNBBreakpointSetIgnoreCount (nub_process_t pid, nub_break_t breakID, nub_size_t ignore_count) DNB_EXPORT;
110nub_bool_t DNBBreakpointSetCallback (nub_process_t pid, nub_break_t breakID, DNBCallbackBreakpointHit callback, void *baton) DNB_EXPORT;
111void DNBBreakpointPrint (nub_process_t pid, nub_break_t breakID) DNB_EXPORT;
112
113//----------------------------------------------------------------------
114// Watchpoint functions
115//----------------------------------------------------------------------
116nub_watch_t DNBWatchpointSet (nub_process_t pid, nub_addr_t addr, nub_size_t size, uint32_t watch_flags, nub_bool_t hardware) DNB_EXPORT;
117nub_bool_t DNBWatchpointClear (nub_process_t pid, nub_watch_t watchID) DNB_EXPORT;
118nub_ssize_t DNBWatchpointGetHitCount (nub_process_t pid, nub_watch_t watchID) DNB_EXPORT;
119nub_ssize_t DNBWatchpointGetIgnoreCount (nub_process_t pid, nub_watch_t watchID) DNB_EXPORT;
120nub_bool_t DNBWatchpointSetIgnoreCount (nub_process_t pid, nub_watch_t watchID, nub_size_t ignore_count) DNB_EXPORT;
121nub_bool_t DNBWatchpointSetCallback (nub_process_t pid, nub_watch_t watchID, DNBCallbackBreakpointHit callback, void *baton) DNB_EXPORT;
122void DNBWatchpointPrint (nub_process_t pid, nub_watch_t watchID) DNB_EXPORT;
123
124const DNBRegisterSetInfo *
125 DNBGetRegisterSetInfo (nub_size_t *num_reg_sets) DNB_EXPORT;
126nub_bool_t DNBGetRegisterInfoByName (const char *reg_name, DNBRegisterInfo* info) DNB_EXPORT;
127
128//----------------------------------------------------------------------
129// Printf style formatting for printing values in the inferior memory
130// space and registers.
131//----------------------------------------------------------------------
132nub_size_t DNBPrintf (nub_process_t pid, nub_thread_t tid, nub_addr_t addr, FILE *file, const char *format) DNB_EXPORT;
133
134//----------------------------------------------------------------------
135// Other static nub information calls.
136//----------------------------------------------------------------------
137const char * DNBStateAsString (nub_state_t state) DNB_EXPORT;
138nub_bool_t DNBResolveExecutablePath (const char *path, char *resolved_path, size_t resolved_path_size) DNB_EXPORT;
139
140#ifdef __cplusplus
141}
142#endif
143
144#endif