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
;
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 inferior PID. Return -1 on failure, and 0 on success. */
134 int (*kill
) (int pid
);
136 /* Detach from inferior PID. Return -1 on failure, and 0 on
139 int (*detach
) (int pid
);
141 /* Wait for inferior PID to exit. */
142 void (*join
) (int pid
);
144 /* Return 1 iff the thread with process ID PID is alive. */
146 int (*thread_alive
) (ptid_t pid
);
148 /* Resume the inferior process. */
150 void (*resume
) (struct thread_resume
*resume_info
, size_t n
);
152 /* Wait for the inferior process or thread to change state. Store
153 status through argument pointer STATUS.
155 PTID = -1 to wait for any pid to do something, PTID(pid,0,0) to
156 wait for any thread of process pid to do something. Return ptid
157 of child, or -1 in case of error; store status through argument
158 pointer STATUS. OPTIONS is a bit set of options defined as
159 TARGET_W* above. If options contains TARGET_WNOHANG and there's
160 no child stop to report, return is
161 null_ptid/TARGET_WAITKIND_IGNORE. */
163 ptid_t (*wait
) (ptid_t ptid
, struct target_waitstatus
*status
, int options
);
165 /* Fetch registers from the inferior process.
167 If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO. */
169 void (*fetch_registers
) (int regno
);
171 /* Store registers to the inferior process.
173 If REGNO is -1, store all registers; otherwise, store at least REGNO. */
175 void (*store_registers
) (int regno
);
177 /* Read memory from the inferior process. This should generally be
178 called through read_inferior_memory, which handles breakpoint shadowing.
180 Read LEN bytes at MEMADDR into a buffer at MYADDR.
182 Returns 0 on success and errno on failure. */
184 int (*read_memory
) (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
186 /* Write memory to the inferior process. This should generally be
187 called through write_inferior_memory, which handles breakpoint shadowing.
189 Write LEN bytes from the buffer at MYADDR to MEMADDR.
191 Returns 0 on success and errno on failure. */
193 int (*write_memory
) (CORE_ADDR memaddr
, const unsigned char *myaddr
,
196 /* Query GDB for the values of any symbols we're interested in.
197 This function is called whenever we receive a "qSymbols::"
198 query, which corresponds to every time more symbols (might)
199 become available. NULL if we aren't interested in any
202 void (*look_up_symbols
) (void);
204 /* Send an interrupt request to the inferior process,
205 however is appropriate. */
207 void (*request_interrupt
) (void);
209 /* Read auxiliary vector data from the inferior process.
211 Read LEN bytes at OFFSET into a buffer at MYADDR. */
213 int (*read_auxv
) (CORE_ADDR offset
, unsigned char *myaddr
,
216 /* Insert and remove a break or watchpoint.
217 Returns 0 on success, -1 on failure and 1 on unsupported.
218 The type is coded as follows:
219 '0' - software-breakpoint
220 '1' - hardware-breakpoint
221 '2' - write watchpoint
222 '3' - read watchpoint
223 '4' - access watchpoint */
225 int (*insert_point
) (char type
, CORE_ADDR addr
, int len
);
226 int (*remove_point
) (char type
, CORE_ADDR addr
, int len
);
228 /* Returns 1 if target was stopped due to a watchpoint hit, 0 otherwise. */
230 int (*stopped_by_watchpoint
) (void);
232 /* Returns the address associated with the watchpoint that hit, if any;
233 returns 0 otherwise. */
235 CORE_ADDR (*stopped_data_address
) (void);
237 /* Reports the text, data offsets of the executable. This is
238 needed for uclinux where the executable is relocated during load
241 int (*read_offsets
) (CORE_ADDR
*text
, CORE_ADDR
*data
);
243 /* Fetch the address associated with a specific thread local storage
244 area, determined by the specified THREAD, OFFSET, and LOAD_MODULE.
245 Stores it in *ADDRESS and returns zero on success; otherwise returns
246 an error code. A return value of -1 means this system does not
247 support the operation. */
249 int (*get_tls_address
) (struct thread_info
*thread
, CORE_ADDR offset
,
250 CORE_ADDR load_module
, CORE_ADDR
*address
);
252 /* Read/Write from/to spufs using qXfer packets. */
253 int (*qxfer_spu
) (const char *annex
, unsigned char *readbuf
,
254 unsigned const char *writebuf
, CORE_ADDR offset
, int len
);
256 /* Fill BUF with an hostio error packet representing the last hostio
258 void (*hostio_last_error
) (char *buf
);
260 /* Read/Write OS data using qXfer packets. */
261 int (*qxfer_osdata
) (const char *annex
, unsigned char *readbuf
,
262 unsigned const char *writebuf
, CORE_ADDR offset
,
265 /* Read/Write extra signal info. */
266 int (*qxfer_siginfo
) (const char *annex
, unsigned char *readbuf
,
267 unsigned const char *writebuf
,
268 CORE_ADDR offset
, int len
);
270 int (*supports_non_stop
) (void);
272 /* Enables async target events. Returns the previous enable
274 int (*async
) (int enable
);
276 /* Switch to non-stop (1) or all-stop (0) mode. Return 0 on
277 success, -1 otherwise. */
278 int (*start_non_stop
) (int);
280 /* Returns true if the target supports multi-process debugging. */
281 int (*supports_multi_process
) (void);
283 /* If not NULL, target-specific routine to process monitor command.
284 Returns 1 if handled, or 0 to perform default processing. */
285 int (*handle_monitor_command
) (char *);
288 extern struct target_ops
*the_target
;
290 void set_target_ops (struct target_ops
*);
292 #define create_inferior(program, args) \
293 (*the_target->create_inferior) (program, args)
295 #define myattach(pid) \
296 (*the_target->attach) (pid)
298 #define kill_inferior(pid) \
299 (*the_target->kill) (pid)
301 #define detach_inferior(pid) \
302 (*the_target->detach) (pid)
304 #define mythread_alive(pid) \
305 (*the_target->thread_alive) (pid)
307 #define fetch_inferior_registers(regno) \
308 (*the_target->fetch_registers) (regno)
310 #define store_inferior_registers(regno) \
311 (*the_target->store_registers) (regno)
313 #define join_inferior(pid) \
314 (*the_target->join) (pid)
316 #define target_supports_non_stop() \
317 (the_target->supports_non_stop ? (*the_target->supports_non_stop ) () : 0)
319 #define target_async(enable) \
320 (the_target->async ? (*the_target->async) (enable) : 0)
322 #define target_supports_multi_process() \
323 (the_target->supports_multi_process ? \
324 (*the_target->supports_multi_process) () : 0)
326 /* Start non-stop mode, returns 0 on success, -1 on failure. */
328 int start_non_stop (int nonstop
);
330 ptid_t
mywait (ptid_t ptid
, struct target_waitstatus
*ourstatus
, int options
,
333 int read_inferior_memory (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
335 int write_inferior_memory (CORE_ADDR memaddr
, const unsigned char *myaddr
,
338 void set_desired_inferior (int id
);
340 const char *target_pid_to_str (ptid_t
);
342 #endif /* TARGET_H */