1 /* Target operations for the remote server for GDB.
2 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
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/>. */
27 /* Ways to "resume" a thread. */
31 /* Thread should continue. */
34 /* Thread should single-step. */
37 /* Thread should be stopped. */
41 /* This structure describes how to resume a particular thread (or all
42 threads) based on the client's request. If thread is -1, then this
43 entry applies to all threads. These are passed around as an
50 /* How to "resume". */
51 enum resume_kind kind
;
53 /* If non-zero, send this signal when we resume, or to stop the
54 thread. If stopping a thread, and this is 0, the target should
55 stop the thread however it best decides to (e.g., SIGSTOP on
56 linux; SuspendThread on win32). */
60 /* Generally, what has the program done? */
63 /* The program has exited. The exit status is in
65 TARGET_WAITKIND_EXITED
,
67 /* The program has stopped with a signal. Which signal is in
69 TARGET_WAITKIND_STOPPED
,
71 /* The program has terminated with a signal. Which signal is in
73 TARGET_WAITKIND_SIGNALLED
,
75 /* The program is letting us know that it dynamically loaded
77 TARGET_WAITKIND_LOADED
,
79 /* The program has exec'ed a new executable file. The new file's
80 pathname is pointed to by value.execd_pathname. */
81 TARGET_WAITKIND_EXECD
,
83 /* Nothing of interest to GDB happened, but we stopped anyway. */
84 TARGET_WAITKIND_SPURIOUS
,
86 /* An event has occurred, but we should wait again. In this case,
87 we want to go back to the event loop and wait there for another
88 event from the inferior. */
89 TARGET_WAITKIND_IGNORE
92 struct target_waitstatus
94 enum target_waitkind kind
;
96 /* Forked child pid, execd pathname, exit status or signal number. */
100 enum target_signal sig
;
102 char *execd_pathname
;
107 /* Options that can be passed to target_ops->wait. */
109 #define TARGET_WNOHANG 1
113 /* Start a new process.
115 PROGRAM is a path to the program to execute.
116 ARGS is a standard NULL-terminated array of arguments,
117 to be passed to the inferior as ``argv''.
119 Returns the new PID on success, -1 on failure. Registers the new
120 process with the process list. */
122 int (*create_inferior
) (char *program
, char **args
);
124 /* Attach to a running process.
126 PID is the process ID to attach to, specified by the user
129 Returns -1 if attaching is unsupported, 0 on success, and calls
130 error() otherwise. */
132 int (*attach
) (unsigned long pid
);
134 /* Kill inferior PID. Return -1 on failure, and 0 on success. */
136 int (*kill
) (int pid
);
138 /* Detach from inferior PID. Return -1 on failure, and 0 on
141 int (*detach
) (int pid
);
143 /* The inferior process has died. Do what is right. */
145 void (*mourn
) (struct process_info
*proc
);
147 /* Wait for inferior PID to exit. */
148 void (*join
) (int pid
);
150 /* Return 1 iff the thread with process ID PID is alive. */
152 int (*thread_alive
) (ptid_t pid
);
154 /* Resume the inferior process. */
156 void (*resume
) (struct thread_resume
*resume_info
, size_t n
);
158 /* Wait for the inferior process or thread to change state. Store
159 status through argument pointer STATUS.
161 PTID = -1 to wait for any pid to do something, PTID(pid,0,0) to
162 wait for any thread of process pid to do something. Return ptid
163 of child, or -1 in case of error; store status through argument
164 pointer STATUS. OPTIONS is a bit set of options defined as
165 TARGET_W* above. If options contains TARGET_WNOHANG and there's
166 no child stop to report, return is
167 null_ptid/TARGET_WAITKIND_IGNORE. */
169 ptid_t (*wait
) (ptid_t ptid
, struct target_waitstatus
*status
, int options
);
171 /* Fetch registers from the inferior process.
173 If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO. */
175 void (*fetch_registers
) (struct regcache
*regcache
, int regno
);
177 /* Store registers to the inferior process.
179 If REGNO is -1, store all registers; otherwise, store at least REGNO. */
181 void (*store_registers
) (struct regcache
*regcache
, int regno
);
183 /* Read memory from the inferior process. This should generally be
184 called through read_inferior_memory, which handles breakpoint shadowing.
186 Read LEN bytes at MEMADDR into a buffer at MYADDR.
188 Returns 0 on success and errno on failure. */
190 int (*read_memory
) (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
192 /* Write memory to the inferior process. This should generally be
193 called through write_inferior_memory, which handles breakpoint shadowing.
195 Write LEN bytes from the buffer at MYADDR to MEMADDR.
197 Returns 0 on success and errno on failure. */
199 int (*write_memory
) (CORE_ADDR memaddr
, const unsigned char *myaddr
,
202 /* Query GDB for the values of any symbols we're interested in.
203 This function is called whenever we receive a "qSymbols::"
204 query, which corresponds to every time more symbols (might)
205 become available. NULL if we aren't interested in any
208 void (*look_up_symbols
) (void);
210 /* Send an interrupt request to the inferior process,
211 however is appropriate. */
213 void (*request_interrupt
) (void);
215 /* Read auxiliary vector data from the inferior process.
217 Read LEN bytes at OFFSET into a buffer at MYADDR. */
219 int (*read_auxv
) (CORE_ADDR offset
, unsigned char *myaddr
,
222 /* Insert and remove a break or watchpoint.
223 Returns 0 on success, -1 on failure and 1 on unsupported.
224 The type is coded as follows:
225 '0' - software-breakpoint
226 '1' - hardware-breakpoint
227 '2' - write watchpoint
228 '3' - read watchpoint
229 '4' - access watchpoint */
231 int (*insert_point
) (char type
, CORE_ADDR addr
, int len
);
232 int (*remove_point
) (char type
, CORE_ADDR addr
, int len
);
234 /* Returns 1 if target was stopped due to a watchpoint hit, 0 otherwise. */
236 int (*stopped_by_watchpoint
) (void);
238 /* Returns the address associated with the watchpoint that hit, if any;
239 returns 0 otherwise. */
241 CORE_ADDR (*stopped_data_address
) (void);
243 /* Reports the text, data offsets of the executable. This is
244 needed for uclinux where the executable is relocated during load
247 int (*read_offsets
) (CORE_ADDR
*text
, CORE_ADDR
*data
);
249 /* Fetch the address associated with a specific thread local storage
250 area, determined by the specified THREAD, OFFSET, and LOAD_MODULE.
251 Stores it in *ADDRESS and returns zero on success; otherwise returns
252 an error code. A return value of -1 means this system does not
253 support the operation. */
255 int (*get_tls_address
) (struct thread_info
*thread
, CORE_ADDR offset
,
256 CORE_ADDR load_module
, CORE_ADDR
*address
);
258 /* Read/Write from/to spufs using qXfer packets. */
259 int (*qxfer_spu
) (const char *annex
, unsigned char *readbuf
,
260 unsigned const char *writebuf
, CORE_ADDR offset
, int len
);
262 /* Fill BUF with an hostio error packet representing the last hostio
264 void (*hostio_last_error
) (char *buf
);
266 /* Read/Write OS data using qXfer packets. */
267 int (*qxfer_osdata
) (const char *annex
, unsigned char *readbuf
,
268 unsigned const char *writebuf
, CORE_ADDR offset
,
271 /* Read/Write extra signal info. */
272 int (*qxfer_siginfo
) (const char *annex
, unsigned char *readbuf
,
273 unsigned const char *writebuf
,
274 CORE_ADDR offset
, int len
);
276 int (*supports_non_stop
) (void);
278 /* Enables async target events. Returns the previous enable
280 int (*async
) (int enable
);
282 /* Switch to non-stop (1) or all-stop (0) mode. Return 0 on
283 success, -1 otherwise. */
284 int (*start_non_stop
) (int);
286 /* Returns true if the target supports multi-process debugging. */
287 int (*supports_multi_process
) (void);
289 /* If not NULL, target-specific routine to process monitor command.
290 Returns 1 if handled, or 0 to perform default processing. */
291 int (*handle_monitor_command
) (char *);
293 /* Returns the core given a thread, or -1 if not known. */
294 int (*core_of_thread
) (ptid_t
);
296 /* Target specific qSupported support. */
297 void (*process_qsupported
) (const char *);
299 /* Return 1 if the target supports tracepoints, 0 (or leave the
300 callback NULL) otherwise. */
301 int (*supports_tracepoints
) (void);
303 /* Read PC from REGCACHE. */
304 CORE_ADDR (*read_pc
) (struct regcache
*regcache
);
306 /* Write PC to REGCACHE. */
307 void (*write_pc
) (struct regcache
*regcache
, CORE_ADDR pc
);
309 /* Return true if THREAD is known to be stopped now. */
310 int (*thread_stopped
) (struct thread_info
*thread
);
312 /* Read Thread Information Block address. */
313 int (*get_tib_address
) (ptid_t ptid
, CORE_ADDR
*address
);
315 /* Pause all threads. If FREEZE, arrange for any resume attempt be
316 be ignored until an unpause_all call unfreezes threads again.
317 There can be nested calls to pause_all, so a freeze counter
318 should be maintained. */
319 void (*pause_all
) (int freeze
);
321 /* Unpause all threads. Threads that hadn't been resumed by the
322 client should be left stopped. Basically a pause/unpause call
323 pair should not end up resuming threads that were stopped before
325 void (*unpause_all
) (int unfreeze
);
327 /* Cancel all pending breakpoints hits in all threads. */
328 void (*cancel_breakpoints
) (void);
330 /* Stabilize all threads. That is, force them out of jump pads. */
331 void (*stabilize_threads
) (void);
333 /* Install a fast tracepoint jump pad. TPOINT is the address of the
334 tracepoint internal object as used by the IPA agent. TPADDR is
335 the address of tracepoint. COLLECTOR is address of the function
336 the jump pad redirects to. LOCKADDR is the address of the jump
337 pad lock object. ORIG_SIZE is the size in bytes of the
338 instruction at TPADDR. JUMP_ENTRY points to the address of the
339 jump pad entry, and on return holds the address past the end of
340 the created jump pad. JJUMP_PAD_INSN is a buffer containing a
341 copy of the instruction at TPADDR. ADJUST_INSN_ADDR and
342 ADJUST_INSN_ADDR_END are output parameters that return the
343 address range where the instruction at TPADDR was relocated
345 int (*install_fast_tracepoint_jump_pad
) (CORE_ADDR tpoint
, CORE_ADDR tpaddr
,
349 CORE_ADDR
*jump_entry
,
350 unsigned char *jjump_pad_insn
,
351 ULONGEST
*jjump_pad_insn_size
,
352 CORE_ADDR
*adjusted_insn_addr
,
353 CORE_ADDR
*adjusted_insn_addr_end
);
355 /* Return the bytecode operations vector for the current inferior.
356 Returns NULL if bytecode compilation is not supported. */
357 struct emit_ops
*(*emit_ops
) (void);
360 extern struct target_ops
*the_target
;
362 void set_target_ops (struct target_ops
*);
364 #define create_inferior(program, args) \
365 (*the_target->create_inferior) (program, args)
367 #define myattach(pid) \
368 (*the_target->attach) (pid)
370 #define kill_inferior(pid) \
371 (*the_target->kill) (pid)
373 #define detach_inferior(pid) \
374 (*the_target->detach) (pid)
376 #define mourn_inferior(PROC) \
377 (*the_target->mourn) (PROC)
379 #define mythread_alive(pid) \
380 (*the_target->thread_alive) (pid)
382 #define fetch_inferior_registers(regcache, regno) \
383 (*the_target->fetch_registers) (regcache, regno)
385 #define store_inferior_registers(regcache, regno) \
386 (*the_target->store_registers) (regcache, regno)
388 #define join_inferior(pid) \
389 (*the_target->join) (pid)
391 #define target_supports_non_stop() \
392 (the_target->supports_non_stop ? (*the_target->supports_non_stop ) () : 0)
394 #define target_async(enable) \
395 (the_target->async ? (*the_target->async) (enable) : 0)
397 #define target_supports_multi_process() \
398 (the_target->supports_multi_process ? \
399 (*the_target->supports_multi_process) () : 0)
401 #define target_process_qsupported(query) \
404 if (the_target->process_qsupported) \
405 the_target->process_qsupported (query); \
408 #define target_supports_tracepoints() \
409 (the_target->supports_tracepoints \
410 ? (*the_target->supports_tracepoints) () : 0)
412 #define target_supports_fast_tracepoints() \
413 (the_target->install_fast_tracepoint_jump_pad != NULL)
415 #define thread_stopped(thread) \
416 (*the_target->thread_stopped) (thread)
418 #define pause_all(freeze) \
421 if (the_target->pause_all) \
422 (*the_target->pause_all) (freeze); \
425 #define unpause_all(unfreeze) \
428 if (the_target->unpause_all) \
429 (*the_target->unpause_all) (unfreeze); \
432 #define cancel_breakpoints() \
435 if (the_target->cancel_breakpoints) \
436 (*the_target->cancel_breakpoints) (); \
439 #define stabilize_threads() \
442 if (the_target->stabilize_threads) \
443 (*the_target->stabilize_threads) (); \
446 #define install_fast_tracepoint_jump_pad(tpoint, tpaddr, \
447 collector, lockaddr, \
449 jump_entry, jjump_pad_insn, \
450 jjump_pad_insn_size, \
451 adjusted_insn_addr, \
452 adjusted_insn_addr_end) \
453 (*the_target->install_fast_tracepoint_jump_pad) (tpoint, tpaddr, \
454 collector,lockaddr, \
455 orig_size, jump_entry, \
457 jjump_pad_insn_size, \
458 adjusted_insn_addr, \
459 adjusted_insn_addr_end)
461 #define target_emit_ops() \
462 (the_target->emit_ops ? (*the_target->emit_ops) () : NULL)
464 /* Start non-stop mode, returns 0 on success, -1 on failure. */
466 int start_non_stop (int nonstop
);
468 ptid_t
mywait (ptid_t ptid
, struct target_waitstatus
*ourstatus
, int options
,
471 int read_inferior_memory (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
473 int write_inferior_memory (CORE_ADDR memaddr
, const unsigned char *myaddr
,
476 void set_desired_inferior (int id
);
478 const char *target_pid_to_str (ptid_t
);
480 const char *target_waitstatus_to_string (const struct target_waitstatus
*);
482 #endif /* TARGET_H */