1 /* Target operations for the remote server for GDB.
2 Copyright (C) 2002-2015 Free Software Foundation, Inc.
4 Contributed by MontaVista Software.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "target/target.h"
25 #include "target/resume.h"
26 #include "target/wait.h"
27 #include "target/waitstatus.h"
28 #include "mem-break.h"
29 #include "btrace-common.h"
35 /* This structure describes how to resume a particular thread (or all
36 threads) based on the client's request. If thread is -1, then this
37 entry applies to all threads. These are passed around as an
44 /* How to "resume". */
45 enum resume_kind kind
;
47 /* If non-zero, send this signal when we resume, or to stop the
48 thread. If stopping a thread, and this is 0, the target should
49 stop the thread however it best decides to (e.g., SIGSTOP on
50 linux; SuspendThread on win32). This is a host signal value (not
54 /* Range to single step within. Valid only iff KIND is resume_step.
56 Single-step once, and then continuing stepping as long as the
57 thread stops in this range. (If the range is empty
58 [STEP_RANGE_START == STEP_RANGE_END], then this is a single-step
60 CORE_ADDR step_range_start
; /* Inclusive */
61 CORE_ADDR step_range_end
; /* Exclusive */
66 /* Start a new process.
68 PROGRAM is a path to the program to execute.
69 ARGS is a standard NULL-terminated array of arguments,
70 to be passed to the inferior as ``argv''.
72 Returns the new PID on success, -1 on failure. Registers the new
73 process with the process list. */
75 int (*create_inferior
) (char *program
, char **args
);
77 /* Architecture-specific setup. */
78 void (*arch_setup
) (void);
80 /* Attach to a running process.
82 PID is the process ID to attach to, specified by the user
85 Returns -1 if attaching is unsupported, 0 on success, and calls
88 int (*attach
) (unsigned long pid
);
90 /* Kill inferior PID. Return -1 on failure, and 0 on success. */
92 int (*kill
) (int pid
);
94 /* Detach from inferior PID. Return -1 on failure, and 0 on
97 int (*detach
) (int pid
);
99 /* The inferior process has died. Do what is right. */
101 void (*mourn
) (struct process_info
*proc
);
103 /* Wait for inferior PID to exit. */
104 void (*join
) (int pid
);
106 /* Return 1 iff the thread with process ID PID is alive. */
108 int (*thread_alive
) (ptid_t pid
);
110 /* Resume the inferior process. */
112 void (*resume
) (struct thread_resume
*resume_info
, size_t n
);
114 /* Wait for the inferior process or thread to change state. Store
115 status through argument pointer STATUS.
117 PTID = -1 to wait for any pid to do something, PTID(pid,0,0) to
118 wait for any thread of process pid to do something. Return ptid
119 of child, or -1 in case of error; store status through argument
120 pointer STATUS. OPTIONS is a bit set of options defined as
121 TARGET_W* above. If options contains TARGET_WNOHANG and there's
122 no child stop to report, return is
123 null_ptid/TARGET_WAITKIND_IGNORE. */
125 ptid_t (*wait
) (ptid_t ptid
, struct target_waitstatus
*status
, int options
);
127 /* Fetch registers from the inferior process.
129 If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO. */
131 void (*fetch_registers
) (struct regcache
*regcache
, int regno
);
133 /* Store registers to the inferior process.
135 If REGNO is -1, store all registers; otherwise, store at least REGNO. */
137 void (*store_registers
) (struct regcache
*regcache
, int regno
);
139 /* Prepare to read or write memory from the inferior process.
140 Targets use this to do what is necessary to get the state of the
141 inferior such that it is possible to access memory.
143 This should generally only be called from client facing routines,
144 such as gdb_read_memory/gdb_write_memory, or the GDB breakpoint
147 Like `read_memory' and `write_memory' below, returns 0 on success
148 and errno on failure. */
150 int (*prepare_to_access_memory
) (void);
152 /* Undo the effects of prepare_to_access_memory. */
154 void (*done_accessing_memory
) (void);
156 /* Read memory from the inferior process. This should generally be
157 called through read_inferior_memory, which handles breakpoint shadowing.
159 Read LEN bytes at MEMADDR into a buffer at MYADDR.
161 Returns 0 on success and errno on failure. */
163 int (*read_memory
) (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
165 /* Write memory to the inferior process. This should generally be
166 called through write_inferior_memory, which handles breakpoint shadowing.
168 Write LEN bytes from the buffer at MYADDR to MEMADDR.
170 Returns 0 on success and errno on failure. */
172 int (*write_memory
) (CORE_ADDR memaddr
, const unsigned char *myaddr
,
175 /* Query GDB for the values of any symbols we're interested in.
176 This function is called whenever we receive a "qSymbols::"
177 query, which corresponds to every time more symbols (might)
178 become available. NULL if we aren't interested in any
181 void (*look_up_symbols
) (void);
183 /* Send an interrupt request to the inferior process,
184 however is appropriate. */
186 void (*request_interrupt
) (void);
188 /* Read auxiliary vector data from the inferior process.
190 Read LEN bytes at OFFSET into a buffer at MYADDR. */
192 int (*read_auxv
) (CORE_ADDR offset
, unsigned char *myaddr
,
195 /* Returns true if GDB Z breakpoint type TYPE is supported, false
196 otherwise. The type is coded as follows:
197 '0' - software-breakpoint
198 '1' - hardware-breakpoint
199 '2' - write watchpoint
200 '3' - read watchpoint
201 '4' - access watchpoint
203 int (*supports_z_point_type
) (char z_type
);
205 /* Insert and remove a break or watchpoint.
206 Returns 0 on success, -1 on failure and 1 on unsupported. */
208 int (*insert_point
) (enum raw_bkpt_type type
, CORE_ADDR addr
,
209 int size
, struct raw_breakpoint
*bp
);
210 int (*remove_point
) (enum raw_bkpt_type type
, CORE_ADDR addr
,
211 int size
, struct raw_breakpoint
*bp
);
213 /* Returns 1 if the target stopped because it executed a software
214 breakpoint instruction, 0 otherwise. */
215 int (*stopped_by_sw_breakpoint
) (void);
217 /* Returns true if the target knows whether a trap was caused by a
218 SW breakpoint triggering. */
219 int (*supports_stopped_by_sw_breakpoint
) (void);
221 /* Returns 1 if the target stopped for a hardware breakpoint. */
222 int (*stopped_by_hw_breakpoint
) (void);
224 /* Returns true if the target knows whether a trap was caused by a
225 HW breakpoint triggering. */
226 int (*supports_stopped_by_hw_breakpoint
) (void);
228 /* Returns true if the target can do hardware single step. */
229 int (*supports_hardware_single_step
) (void);
231 /* Returns 1 if target was stopped due to a watchpoint hit, 0 otherwise. */
233 int (*stopped_by_watchpoint
) (void);
235 /* Returns the address associated with the watchpoint that hit, if any;
236 returns 0 otherwise. */
238 CORE_ADDR (*stopped_data_address
) (void);
240 /* Reports the text, data offsets of the executable. This is
241 needed for uclinux where the executable is relocated during load
244 int (*read_offsets
) (CORE_ADDR
*text
, CORE_ADDR
*data
);
246 /* Fetch the address associated with a specific thread local storage
247 area, determined by the specified THREAD, OFFSET, and LOAD_MODULE.
248 Stores it in *ADDRESS and returns zero on success; otherwise returns
249 an error code. A return value of -1 means this system does not
250 support the operation. */
252 int (*get_tls_address
) (struct thread_info
*thread
, CORE_ADDR offset
,
253 CORE_ADDR load_module
, CORE_ADDR
*address
);
255 /* Read/Write from/to spufs using qXfer packets. */
256 int (*qxfer_spu
) (const char *annex
, unsigned char *readbuf
,
257 unsigned const char *writebuf
, CORE_ADDR offset
, int len
);
259 /* Fill BUF with an hostio error packet representing the last hostio
261 void (*hostio_last_error
) (char *buf
);
263 /* Read/Write OS data using qXfer packets. */
264 int (*qxfer_osdata
) (const char *annex
, unsigned char *readbuf
,
265 unsigned const char *writebuf
, CORE_ADDR offset
,
268 /* Read/Write extra signal info. */
269 int (*qxfer_siginfo
) (const char *annex
, unsigned char *readbuf
,
270 unsigned const char *writebuf
,
271 CORE_ADDR offset
, int len
);
273 int (*supports_non_stop
) (void);
275 /* Enables async target events. Returns the previous enable
277 int (*async
) (int enable
);
279 /* Switch to non-stop (1) or all-stop (0) mode. Return 0 on
280 success, -1 otherwise. */
281 int (*start_non_stop
) (int);
283 /* Returns true if the target supports multi-process debugging. */
284 int (*supports_multi_process
) (void);
286 /* Returns true if fork events are supported. */
287 int (*supports_fork_events
) (void);
289 /* Returns true if vfork events are supported. */
290 int (*supports_vfork_events
) (void);
292 /* Returns true if exec events are supported. */
293 int (*supports_exec_events
) (void);
295 /* Allows target to re-initialize connection-specific settings. */
296 void (*handle_new_gdb_connection
) (void);
298 /* If not NULL, target-specific routine to process monitor command.
299 Returns 1 if handled, or 0 to perform default processing. */
300 int (*handle_monitor_command
) (char *);
302 /* Returns the core given a thread, or -1 if not known. */
303 int (*core_of_thread
) (ptid_t
);
305 /* Read loadmaps. Read LEN bytes at OFFSET into a buffer at MYADDR. */
306 int (*read_loadmap
) (const char *annex
, CORE_ADDR offset
,
307 unsigned char *myaddr
, unsigned int len
);
309 /* Target specific qSupported support. */
310 void (*process_qsupported
) (const char *);
312 /* Return 1 if the target supports tracepoints, 0 (or leave the
313 callback NULL) otherwise. */
314 int (*supports_tracepoints
) (void);
316 /* Read PC from REGCACHE. */
317 CORE_ADDR (*read_pc
) (struct regcache
*regcache
);
319 /* Write PC to REGCACHE. */
320 void (*write_pc
) (struct regcache
*regcache
, CORE_ADDR pc
);
322 /* Return true if THREAD is known to be stopped now. */
323 int (*thread_stopped
) (struct thread_info
*thread
);
325 /* Read Thread Information Block address. */
326 int (*get_tib_address
) (ptid_t ptid
, CORE_ADDR
*address
);
328 /* Pause all threads. If FREEZE, arrange for any resume attempt to
329 be ignored until an unpause_all call unfreezes threads again.
330 There can be nested calls to pause_all, so a freeze counter
331 should be maintained. */
332 void (*pause_all
) (int freeze
);
334 /* Unpause all threads. Threads that hadn't been resumed by the
335 client should be left stopped. Basically a pause/unpause call
336 pair should not end up resuming threads that were stopped before
338 void (*unpause_all
) (int unfreeze
);
340 /* Stabilize all threads. That is, force them out of jump pads. */
341 void (*stabilize_threads
) (void);
343 /* Install a fast tracepoint jump pad. TPOINT is the address of the
344 tracepoint internal object as used by the IPA agent. TPADDR is
345 the address of tracepoint. COLLECTOR is address of the function
346 the jump pad redirects to. LOCKADDR is the address of the jump
347 pad lock object. ORIG_SIZE is the size in bytes of the
348 instruction at TPADDR. JUMP_ENTRY points to the address of the
349 jump pad entry, and on return holds the address past the end of
350 the created jump pad. If a trampoline is created by the function,
351 then TRAMPOLINE and TRAMPOLINE_SIZE return the address and size of
352 the trampoline, else they remain unchanged. JJUMP_PAD_INSN is a
353 buffer containing a copy of the instruction at TPADDR.
354 ADJUST_INSN_ADDR and ADJUST_INSN_ADDR_END are output parameters that
355 return the address range where the instruction at TPADDR was relocated
356 to. If an error occurs, the ERR may be used to pass on an error
358 int (*install_fast_tracepoint_jump_pad
) (CORE_ADDR tpoint
, CORE_ADDR tpaddr
,
362 CORE_ADDR
*jump_entry
,
363 CORE_ADDR
*trampoline
,
364 ULONGEST
*trampoline_size
,
365 unsigned char *jjump_pad_insn
,
366 ULONGEST
*jjump_pad_insn_size
,
367 CORE_ADDR
*adjusted_insn_addr
,
368 CORE_ADDR
*adjusted_insn_addr_end
,
371 /* Return the bytecode operations vector for the current inferior.
372 Returns NULL if bytecode compilation is not supported. */
373 struct emit_ops
*(*emit_ops
) (void);
375 /* Returns true if the target supports disabling randomization. */
376 int (*supports_disable_randomization
) (void);
378 /* Return the minimum length of an instruction that can be safely overwritten
379 for use as a fast tracepoint. */
380 int (*get_min_fast_tracepoint_insn_len
) (void);
382 /* Read solib info on SVR4 platforms. */
383 int (*qxfer_libraries_svr4
) (const char *annex
, unsigned char *readbuf
,
384 unsigned const char *writebuf
,
385 CORE_ADDR offset
, int len
);
387 /* Return true if target supports debugging agent. */
388 int (*supports_agent
) (void);
390 /* Check whether the target supports branch tracing. */
391 int (*supports_btrace
) (struct target_ops
*, enum btrace_format
);
393 /* Enable branch tracing for PTID based on CONF and allocate a branch trace
394 target information struct for reading and for disabling branch trace. */
395 struct btrace_target_info
*(*enable_btrace
)
396 (ptid_t ptid
, const struct btrace_config
*conf
);
398 /* Disable branch tracing.
399 Returns zero on success, non-zero otherwise. */
400 int (*disable_btrace
) (struct btrace_target_info
*tinfo
);
402 /* Read branch trace data into buffer. We use an int to specify the type
403 to break a cyclic dependency.
404 Return 0 on success; print an error message into BUFFER and return -1,
406 int (*read_btrace
) (struct btrace_target_info
*, struct buffer
*, int type
);
408 /* Read the branch trace configuration into BUFFER.
409 Return 0 on success; print an error message into BUFFER and return -1
411 int (*read_btrace_conf
) (const struct btrace_target_info
*, struct buffer
*);
413 /* Return true if target supports range stepping. */
414 int (*supports_range_stepping
) (void);
416 /* Return the full absolute name of the executable file that was
417 run to create the process PID. If the executable file cannot
418 be determined, NULL is returned. Otherwise, a pointer to a
419 character string containing the pathname is returned. This
420 string should be copied into a buffer by the client if the string
421 will not be immediately used, or if it must persist. */
422 char *(*pid_to_exec_file
) (int pid
);
424 /* Multiple-filesystem-aware open. Like open(2), but operating in
425 the filesystem as it appears to process PID. Systems where all
426 processes share a common filesystem should set this to NULL.
427 If NULL, the caller should fall back to open(2). */
428 int (*multifs_open
) (int pid
, const char *filename
,
429 int flags
, mode_t mode
);
431 /* Multiple-filesystem-aware unlink. Like unlink(2), but operates
432 in the filesystem as it appears to process PID. Systems where
433 all processes share a common filesystem should set this to NULL.
434 If NULL, the caller should fall back to unlink(2). */
435 int (*multifs_unlink
) (int pid
, const char *filename
);
437 /* Multiple-filesystem-aware readlink. Like readlink(2), but
438 operating in the filesystem as it appears to process PID.
439 Systems where all processes share a common filesystem should
440 set this to NULL. If NULL, the caller should fall back to
442 ssize_t (*multifs_readlink
) (int pid
, const char *filename
,
443 char *buf
, size_t bufsiz
);
446 extern struct target_ops
*the_target
;
448 void set_target_ops (struct target_ops
*);
450 #define create_inferior(program, args) \
451 (*the_target->create_inferior) (program, args)
453 #define target_arch_setup() \
456 if (the_target->arch_setup != NULL) \
457 (*the_target->arch_setup) (); \
460 #define myattach(pid) \
461 (*the_target->attach) (pid)
463 int kill_inferior (int);
465 #define target_supports_fork_events() \
466 (the_target->supports_fork_events ? \
467 (*the_target->supports_fork_events) () : 0)
469 #define target_supports_vfork_events() \
470 (the_target->supports_vfork_events ? \
471 (*the_target->supports_vfork_events) () : 0)
473 #define target_supports_exec_events() \
474 (the_target->supports_exec_events ? \
475 (*the_target->supports_exec_events) () : 0)
477 #define target_handle_new_gdb_connection() \
480 if (the_target->handle_new_gdb_connection != NULL) \
481 (*the_target->handle_new_gdb_connection) (); \
484 #define detach_inferior(pid) \
485 (*the_target->detach) (pid)
487 #define mourn_inferior(PROC) \
488 (*the_target->mourn) (PROC)
490 #define mythread_alive(pid) \
491 (*the_target->thread_alive) (pid)
493 #define fetch_inferior_registers(regcache, regno) \
494 (*the_target->fetch_registers) (regcache, regno)
496 #define store_inferior_registers(regcache, regno) \
497 (*the_target->store_registers) (regcache, regno)
499 #define join_inferior(pid) \
500 (*the_target->join) (pid)
502 #define target_supports_non_stop() \
503 (the_target->supports_non_stop ? (*the_target->supports_non_stop ) () : 0)
505 #define target_async(enable) \
506 (the_target->async ? (*the_target->async) (enable) : 0)
508 #define target_supports_multi_process() \
509 (the_target->supports_multi_process ? \
510 (*the_target->supports_multi_process) () : 0)
512 #define target_process_qsupported(query) \
515 if (the_target->process_qsupported) \
516 the_target->process_qsupported (query); \
519 #define target_supports_tracepoints() \
520 (the_target->supports_tracepoints \
521 ? (*the_target->supports_tracepoints) () : 0)
523 #define target_supports_fast_tracepoints() \
524 (the_target->install_fast_tracepoint_jump_pad != NULL)
526 #define target_get_min_fast_tracepoint_insn_len() \
527 (the_target->get_min_fast_tracepoint_insn_len \
528 ? (*the_target->get_min_fast_tracepoint_insn_len) () : 0)
530 #define thread_stopped(thread) \
531 (*the_target->thread_stopped) (thread)
533 #define pause_all(freeze) \
536 if (the_target->pause_all) \
537 (*the_target->pause_all) (freeze); \
540 #define unpause_all(unfreeze) \
543 if (the_target->unpause_all) \
544 (*the_target->unpause_all) (unfreeze); \
547 #define stabilize_threads() \
550 if (the_target->stabilize_threads) \
551 (*the_target->stabilize_threads) (); \
554 #define install_fast_tracepoint_jump_pad(tpoint, tpaddr, \
555 collector, lockaddr, \
558 trampoline, trampoline_size, \
560 jjump_pad_insn_size, \
561 adjusted_insn_addr, \
562 adjusted_insn_addr_end, \
564 (*the_target->install_fast_tracepoint_jump_pad) (tpoint, tpaddr, \
565 collector,lockaddr, \
566 orig_size, jump_entry, \
570 jjump_pad_insn_size, \
571 adjusted_insn_addr, \
572 adjusted_insn_addr_end, \
575 #define target_emit_ops() \
576 (the_target->emit_ops ? (*the_target->emit_ops) () : NULL)
578 #define target_supports_disable_randomization() \
579 (the_target->supports_disable_randomization ? \
580 (*the_target->supports_disable_randomization) () : 0)
582 #define target_supports_agent() \
583 (the_target->supports_agent ? \
584 (*the_target->supports_agent) () : 0)
586 #define target_supports_btrace(format) \
587 (the_target->supports_btrace \
588 ? (*the_target->supports_btrace) (the_target, format) : 0)
590 #define target_enable_btrace(ptid, conf) \
591 (*the_target->enable_btrace) (ptid, conf)
593 #define target_disable_btrace(tinfo) \
594 (*the_target->disable_btrace) (tinfo)
596 #define target_read_btrace(tinfo, buffer, type) \
597 (*the_target->read_btrace) (tinfo, buffer, type)
599 #define target_read_btrace_conf(tinfo, buffer) \
600 (*the_target->read_btrace_conf) (tinfo, buffer)
602 #define target_supports_range_stepping() \
603 (the_target->supports_range_stepping ? \
604 (*the_target->supports_range_stepping) () : 0)
606 #define target_supports_stopped_by_sw_breakpoint() \
607 (the_target->supports_stopped_by_sw_breakpoint ? \
608 (*the_target->supports_stopped_by_sw_breakpoint) () : 0)
610 #define target_stopped_by_sw_breakpoint() \
611 (the_target->stopped_by_sw_breakpoint ? \
612 (*the_target->stopped_by_sw_breakpoint) () : 0)
614 #define target_supports_stopped_by_hw_breakpoint() \
615 (the_target->supports_stopped_by_hw_breakpoint ? \
616 (*the_target->supports_stopped_by_hw_breakpoint) () : 0)
618 #define target_supports_hardware_single_step() \
619 (the_target->supports_hardware_single_step ? \
620 (*the_target->supports_hardware_single_step) () : 0)
622 #define target_stopped_by_hw_breakpoint() \
623 (the_target->stopped_by_hw_breakpoint ? \
624 (*the_target->stopped_by_hw_breakpoint) () : 0)
626 /* Start non-stop mode, returns 0 on success, -1 on failure. */
628 int start_non_stop (int nonstop
);
630 ptid_t
mywait (ptid_t ptid
, struct target_waitstatus
*ourstatus
, int options
,
633 #define prepare_to_access_memory() \
634 (the_target->prepare_to_access_memory \
635 ? (*the_target->prepare_to_access_memory) () \
638 #define done_accessing_memory() \
641 if (the_target->done_accessing_memory) \
642 (*the_target->done_accessing_memory) (); \
645 #define target_core_of_thread(ptid) \
646 (the_target->core_of_thread ? (*the_target->core_of_thread) (ptid) \
649 int read_inferior_memory (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
651 int write_inferior_memory (CORE_ADDR memaddr
, const unsigned char *myaddr
,
654 int set_desired_thread (int id
);
656 const char *target_pid_to_str (ptid_t
);
658 int target_can_do_hardware_single_step (void);
660 #endif /* TARGET_H */