1 /* Target operations for the remote server for GDB.
2 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009
3 Free Software Foundation, Inc.
5 Contributed by MontaVista Software.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
25 /* Ways to "resume" a thread. */
29 /* Thread should continue. */
32 /* Thread should single-step. */
35 /* Thread should be stopped. */
39 /* This structure describes how to resume a particular thread (or all
40 threads) based on the client's request. If thread is -1, then this
41 entry applies to all threads. These are passed around as an
48 /* How to "resume". */
49 enum resume_kind kind
;
51 /* If non-zero, send this signal when we resume, or to stop the
52 thread. If stopping a thread, and this is 0, the target should
53 stop the thread however it best decides to (e.g., SIGSTOP on
54 linux; SuspendThread on win32). */
58 /* Generally, what has the program done? */
61 /* The program has exited. The exit status is in
63 TARGET_WAITKIND_EXITED
,
65 /* The program has stopped with a signal. Which signal is in
67 TARGET_WAITKIND_STOPPED
,
69 /* The program has terminated with a signal. Which signal is in
71 TARGET_WAITKIND_SIGNALLED
,
73 /* The program is letting us know that it dynamically loaded
75 TARGET_WAITKIND_LOADED
,
77 /* The program has exec'ed a new executable file. The new file's
78 pathname is pointed to by value.execd_pathname. */
79 TARGET_WAITKIND_EXECD
,
81 /* Nothing of interest to GDB happened, but we stopped anyway. */
82 TARGET_WAITKIND_SPURIOUS
,
84 /* An event has occurred, but we should wait again. In this case,
85 we want to go back to the event loop and wait there for another
86 event from the inferior. */
87 TARGET_WAITKIND_IGNORE
90 struct target_waitstatus
92 enum target_waitkind kind
;
94 /* Forked child pid, execd pathname, exit status or signal number. */
98 enum target_signal sig
;
99 unsigned long related_pid
;
100 char *execd_pathname
;
105 /* Options that can be passed to target_ops->wait. */
107 #define TARGET_WNOHANG 1
111 /* Start a new process.
113 PROGRAM is a path to the program to execute.
114 ARGS is a standard NULL-terminated array of arguments,
115 to be passed to the inferior as ``argv''.
117 Returns the new PID on success, -1 on failure. Registers the new
118 process with the process list. */
120 int (*create_inferior
) (char *program
, char **args
);
122 /* Attach to a running process.
124 PID is the process ID to attach to, specified by the user
127 Returns -1 if attaching is unsupported, 0 on success, and calls
128 error() otherwise. */
130 int (*attach
) (unsigned long pid
);
132 /* Kill all inferiors. */
136 /* Detach from all inferiors.
137 Return -1 on failure, and 0 on success. */
139 int (*detach
) (void);
141 /* Wait for inferiors to end. */
145 /* Return 1 iff the thread with process ID PID is alive. */
147 int (*thread_alive
) (unsigned long pid
);
149 /* Resume the inferior process. */
151 void (*resume
) (struct thread_resume
*resume_info
, size_t n
);
153 /* Wait for the inferior process or thread to change state. Store
154 status through argument pointer STATUS. */
156 unsigned long (*wait
) (struct target_waitstatus
*status
, int options
);
158 /* Fetch registers from the inferior process.
160 If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO. */
162 void (*fetch_registers
) (int regno
);
164 /* Store registers to the inferior process.
166 If REGNO is -1, store all registers; otherwise, store at least REGNO. */
168 void (*store_registers
) (int regno
);
170 /* Read memory from the inferior process. This should generally be
171 called through read_inferior_memory, which handles breakpoint shadowing.
173 Read LEN bytes at MEMADDR into a buffer at MYADDR.
175 Returns 0 on success and errno on failure. */
177 int (*read_memory
) (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
179 /* Write memory to the inferior process. This should generally be
180 called through write_inferior_memory, which handles breakpoint shadowing.
182 Write LEN bytes from the buffer at MYADDR to MEMADDR.
184 Returns 0 on success and errno on failure. */
186 int (*write_memory
) (CORE_ADDR memaddr
, const unsigned char *myaddr
,
189 /* Query GDB for the values of any symbols we're interested in.
190 This function is called whenever we receive a "qSymbols::"
191 query, which corresponds to every time more symbols (might)
192 become available. NULL if we aren't interested in any
195 void (*look_up_symbols
) (void);
197 /* Send an interrupt request to the inferior process,
198 however is appropriate. */
200 void (*request_interrupt
) (void);
202 /* Read auxiliary vector data from the inferior process.
204 Read LEN bytes at OFFSET into a buffer at MYADDR. */
206 int (*read_auxv
) (CORE_ADDR offset
, unsigned char *myaddr
,
209 /* Insert and remove a hardware watchpoint.
210 Returns 0 on success, -1 on failure and 1 on unsupported.
211 The type is coded as follows:
214 4 = access watchpoint
217 int (*insert_watchpoint
) (char type
, CORE_ADDR addr
, int len
);
218 int (*remove_watchpoint
) (char type
, CORE_ADDR addr
, int len
);
220 /* Returns 1 if target was stopped due to a watchpoint hit, 0 otherwise. */
222 int (*stopped_by_watchpoint
) (void);
224 /* Returns the address associated with the watchpoint that hit, if any;
225 returns 0 otherwise. */
227 CORE_ADDR (*stopped_data_address
) (void);
229 /* Reports the text, data offsets of the executable. This is
230 needed for uclinux where the executable is relocated during load
233 int (*read_offsets
) (CORE_ADDR
*text
, CORE_ADDR
*data
);
235 /* Fetch the address associated with a specific thread local storage
236 area, determined by the specified THREAD, OFFSET, and LOAD_MODULE.
237 Stores it in *ADDRESS and returns zero on success; otherwise returns
238 an error code. A return value of -1 means this system does not
239 support the operation. */
241 int (*get_tls_address
) (struct thread_info
*thread
, CORE_ADDR offset
,
242 CORE_ADDR load_module
, CORE_ADDR
*address
);
244 /* Read/Write from/to spufs using qXfer packets. */
245 int (*qxfer_spu
) (const char *annex
, unsigned char *readbuf
,
246 unsigned const char *writebuf
, CORE_ADDR offset
, int len
);
248 /* Fill BUF with an hostio error packet representing the last hostio
250 void (*hostio_last_error
) (char *buf
);
252 /* Read/Write OS data using qXfer packets. */
253 int (*qxfer_osdata
) (const char *annex
, unsigned char *readbuf
,
254 unsigned const char *writebuf
, CORE_ADDR offset
,
257 /* Read/Write extra signal info. */
258 int (*qxfer_siginfo
) (const char *annex
, unsigned char *readbuf
,
259 unsigned const char *writebuf
,
260 CORE_ADDR offset
, int len
);
262 int (*supports_non_stop
) (void);
264 /* Enables async target events. Returns the previous enable
266 int (*async
) (int enable
);
268 /* Switch to non-stop (1) or all-stop (0) mode. Return 0 on
269 success, -1 otherwise. */
270 int (*start_non_stop
) (int);
273 extern struct target_ops
*the_target
;
275 void set_target_ops (struct target_ops
*);
277 #define create_inferior(program, args) \
278 (*the_target->create_inferior) (program, args)
280 #define myattach(pid) \
281 (*the_target->attach) (pid)
283 #define kill_inferior() \
284 (*the_target->kill) ()
286 #define detach_inferior() \
287 (*the_target->detach) ()
289 #define mythread_alive(pid) \
290 (*the_target->thread_alive) (pid)
292 #define fetch_inferior_registers(regno) \
293 (*the_target->fetch_registers) (regno)
295 #define store_inferior_registers(regno) \
296 (*the_target->store_registers) (regno)
298 #define join_inferior() \
299 (*the_target->join) ()
301 #define target_supports_non_stop() \
302 (the_target->supports_non_stop ? (*the_target->supports_non_stop ) () : 0)
304 #define target_async(enable) \
305 (the_target->async ? (*the_target->async) (enable) : 0)
307 /* Start non-stop mode, returns 0 on success, -1 on failure. */
309 int start_non_stop (int nonstop
);
311 unsigned long mywait (struct target_waitstatus
*ourstatus
, int options
,
314 int read_inferior_memory (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
316 int write_inferior_memory (CORE_ADDR memaddr
, const unsigned char *myaddr
,
319 void set_desired_inferior (int id
);
321 #endif /* TARGET_H */