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 <sys/types.h> /* for mode_t */
25 #include "target/target.h"
26 #include "target/resume.h"
27 #include "target/wait.h"
28 #include "target/waitstatus.h"
29 #include "mem-break.h"
30 #include "btrace-common.h"
36 /* This structure describes how to resume a particular thread (or all
37 threads) based on the client's request. If thread is -1, then this
38 entry applies to all threads. These are passed around as an
45 /* How to "resume". */
46 enum resume_kind kind
;
48 /* If non-zero, send this signal when we resume, or to stop the
49 thread. If stopping a thread, and this is 0, the target should
50 stop the thread however it best decides to (e.g., SIGSTOP on
51 linux; SuspendThread on win32). This is a host signal value (not
55 /* Range to single step within. Valid only iff KIND is resume_step.
57 Single-step once, and then continuing stepping as long as the
58 thread stops in this range. (If the range is empty
59 [STEP_RANGE_START == STEP_RANGE_END], then this is a single-step
61 CORE_ADDR step_range_start
; /* Inclusive */
62 CORE_ADDR step_range_end
; /* Exclusive */
67 /* Start a new process.
69 PROGRAM is a path to the program to execute.
70 ARGS is a standard NULL-terminated array of arguments,
71 to be passed to the inferior as ``argv''.
73 Returns the new PID on success, -1 on failure. Registers the new
74 process with the process list. */
76 int (*create_inferior
) (char *program
, char **args
);
78 /* Architecture-specific setup. */
79 void (*arch_setup
) (void);
81 /* Attach to a running process.
83 PID is the process ID to attach to, specified by the user
86 Returns -1 if attaching is unsupported, 0 on success, and calls
89 int (*attach
) (unsigned long pid
);
91 /* Kill inferior PID. Return -1 on failure, and 0 on success. */
93 int (*kill
) (int pid
);
95 /* Detach from inferior PID. Return -1 on failure, and 0 on
98 int (*detach
) (int pid
);
100 /* The inferior process has died. Do what is right. */
102 void (*mourn
) (struct process_info
*proc
);
104 /* Wait for inferior PID to exit. */
105 void (*join
) (int pid
);
107 /* Return 1 iff the thread with process ID PID is alive. */
109 int (*thread_alive
) (ptid_t pid
);
111 /* Resume the inferior process. */
113 void (*resume
) (struct thread_resume
*resume_info
, size_t n
);
115 /* Wait for the inferior process or thread to change state. Store
116 status through argument pointer STATUS.
118 PTID = -1 to wait for any pid to do something, PTID(pid,0,0) to
119 wait for any thread of process pid to do something. Return ptid
120 of child, or -1 in case of error; store status through argument
121 pointer STATUS. OPTIONS is a bit set of options defined as
122 TARGET_W* above. If options contains TARGET_WNOHANG and there's
123 no child stop to report, return is
124 null_ptid/TARGET_WAITKIND_IGNORE. */
126 ptid_t (*wait
) (ptid_t ptid
, struct target_waitstatus
*status
, int options
);
128 /* Fetch registers from the inferior process.
130 If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO. */
132 void (*fetch_registers
) (struct regcache
*regcache
, int regno
);
134 /* Store registers to the inferior process.
136 If REGNO is -1, store all registers; otherwise, store at least REGNO. */
138 void (*store_registers
) (struct regcache
*regcache
, int regno
);
140 /* Prepare to read or write memory from the inferior process.
141 Targets use this to do what is necessary to get the state of the
142 inferior such that it is possible to access memory.
144 This should generally only be called from client facing routines,
145 such as gdb_read_memory/gdb_write_memory, or the GDB breakpoint
148 Like `read_memory' and `write_memory' below, returns 0 on success
149 and errno on failure. */
151 int (*prepare_to_access_memory
) (void);
153 /* Undo the effects of prepare_to_access_memory. */
155 void (*done_accessing_memory
) (void);
157 /* Read memory from the inferior process. This should generally be
158 called through read_inferior_memory, which handles breakpoint shadowing.
160 Read LEN bytes at MEMADDR into a buffer at MYADDR.
162 Returns 0 on success and errno on failure. */
164 int (*read_memory
) (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
166 /* Write memory to the inferior process. This should generally be
167 called through write_inferior_memory, which handles breakpoint shadowing.
169 Write LEN bytes from the buffer at MYADDR to MEMADDR.
171 Returns 0 on success and errno on failure. */
173 int (*write_memory
) (CORE_ADDR memaddr
, const unsigned char *myaddr
,
176 /* Query GDB for the values of any symbols we're interested in.
177 This function is called whenever we receive a "qSymbols::"
178 query, which corresponds to every time more symbols (might)
179 become available. NULL if we aren't interested in any
182 void (*look_up_symbols
) (void);
184 /* Send an interrupt request to the inferior process,
185 however is appropriate. */
187 void (*request_interrupt
) (void);
189 /* Read auxiliary vector data from the inferior process.
191 Read LEN bytes at OFFSET into a buffer at MYADDR. */
193 int (*read_auxv
) (CORE_ADDR offset
, unsigned char *myaddr
,
196 /* Returns true if GDB Z breakpoint type TYPE is supported, false
197 otherwise. The type is coded as follows:
198 '0' - software-breakpoint
199 '1' - hardware-breakpoint
200 '2' - write watchpoint
201 '3' - read watchpoint
202 '4' - access watchpoint
204 int (*supports_z_point_type
) (char z_type
);
206 /* Insert and remove a break or watchpoint.
207 Returns 0 on success, -1 on failure and 1 on unsupported. */
209 int (*insert_point
) (enum raw_bkpt_type type
, CORE_ADDR addr
,
210 int size
, struct raw_breakpoint
*bp
);
211 int (*remove_point
) (enum raw_bkpt_type type
, CORE_ADDR addr
,
212 int size
, struct raw_breakpoint
*bp
);
214 /* Returns 1 if the target stopped because it executed a software
215 breakpoint instruction, 0 otherwise. */
216 int (*stopped_by_sw_breakpoint
) (void);
218 /* Returns true if the target knows whether a trap was caused by a
219 SW breakpoint triggering. */
220 int (*supports_stopped_by_sw_breakpoint
) (void);
222 /* Returns 1 if the target stopped for a hardware breakpoint. */
223 int (*stopped_by_hw_breakpoint
) (void);
225 /* Returns true if the target knows whether a trap was caused by a
226 HW breakpoint triggering. */
227 int (*supports_stopped_by_hw_breakpoint
) (void);
229 /* Returns true if the target can do hardware single step. */
230 int (*supports_hardware_single_step
) (void);
232 /* Returns 1 if target was stopped due to a watchpoint hit, 0 otherwise. */
234 int (*stopped_by_watchpoint
) (void);
236 /* Returns the address associated with the watchpoint that hit, if any;
237 returns 0 otherwise. */
239 CORE_ADDR (*stopped_data_address
) (void);
241 /* Reports the text, data offsets of the executable. This is
242 needed for uclinux where the executable is relocated during load
245 int (*read_offsets
) (CORE_ADDR
*text
, CORE_ADDR
*data
);
247 /* Fetch the address associated with a specific thread local storage
248 area, determined by the specified THREAD, OFFSET, and LOAD_MODULE.
249 Stores it in *ADDRESS and returns zero on success; otherwise returns
250 an error code. A return value of -1 means this system does not
251 support the operation. */
253 int (*get_tls_address
) (struct thread_info
*thread
, CORE_ADDR offset
,
254 CORE_ADDR load_module
, CORE_ADDR
*address
);
256 /* Read/Write from/to spufs using qXfer packets. */
257 int (*qxfer_spu
) (const char *annex
, unsigned char *readbuf
,
258 unsigned const char *writebuf
, CORE_ADDR offset
, int len
);
260 /* Fill BUF with an hostio error packet representing the last hostio
262 void (*hostio_last_error
) (char *buf
);
264 /* Read/Write OS data using qXfer packets. */
265 int (*qxfer_osdata
) (const char *annex
, unsigned char *readbuf
,
266 unsigned const char *writebuf
, CORE_ADDR offset
,
269 /* Read/Write extra signal info. */
270 int (*qxfer_siginfo
) (const char *annex
, unsigned char *readbuf
,
271 unsigned const char *writebuf
,
272 CORE_ADDR offset
, int len
);
274 int (*supports_non_stop
) (void);
276 /* Enables async target events. Returns the previous enable
278 int (*async
) (int enable
);
280 /* Switch to non-stop (1) or all-stop (0) mode. Return 0 on
281 success, -1 otherwise. */
282 int (*start_non_stop
) (int);
284 /* Returns true if the target supports multi-process debugging. */
285 int (*supports_multi_process
) (void);
287 /* Returns true if fork events are supported. */
288 int (*supports_fork_events
) (void);
290 /* Returns true if vfork events are supported. */
291 int (*supports_vfork_events
) (void);
293 /* Returns true if exec events are supported. */
294 int (*supports_exec_events
) (void);
296 /* Allows target to re-initialize connection-specific settings. */
297 void (*handle_new_gdb_connection
) (void);
299 /* If not NULL, target-specific routine to process monitor command.
300 Returns 1 if handled, or 0 to perform default processing. */
301 int (*handle_monitor_command
) (char *);
303 /* Returns the core given a thread, or -1 if not known. */
304 int (*core_of_thread
) (ptid_t
);
306 /* Read loadmaps. Read LEN bytes at OFFSET into a buffer at MYADDR. */
307 int (*read_loadmap
) (const char *annex
, CORE_ADDR offset
,
308 unsigned char *myaddr
, unsigned int len
);
310 /* Target specific qSupported support. FEATURES is an array of
311 features with COUNT elements. */
312 void (*process_qsupported
) (char **features
, int count
);
314 /* Return 1 if the target supports tracepoints, 0 (or leave the
315 callback NULL) otherwise. */
316 int (*supports_tracepoints
) (void);
318 /* Read PC from REGCACHE. */
319 CORE_ADDR (*read_pc
) (struct regcache
*regcache
);
321 /* Write PC to REGCACHE. */
322 void (*write_pc
) (struct regcache
*regcache
, CORE_ADDR pc
);
324 /* Return true if THREAD is known to be stopped now. */
325 int (*thread_stopped
) (struct thread_info
*thread
);
327 /* Read Thread Information Block address. */
328 int (*get_tib_address
) (ptid_t ptid
, CORE_ADDR
*address
);
330 /* Pause all threads. If FREEZE, arrange for any resume attempt to
331 be ignored until an unpause_all call unfreezes threads again.
332 There can be nested calls to pause_all, so a freeze counter
333 should be maintained. */
334 void (*pause_all
) (int freeze
);
336 /* Unpause all threads. Threads that hadn't been resumed by the
337 client should be left stopped. Basically a pause/unpause call
338 pair should not end up resuming threads that were stopped before
340 void (*unpause_all
) (int unfreeze
);
342 /* Stabilize all threads. That is, force them out of jump pads. */
343 void (*stabilize_threads
) (void);
345 /* Install a fast tracepoint jump pad. TPOINT is the address of the
346 tracepoint internal object as used by the IPA agent. TPADDR is
347 the address of tracepoint. COLLECTOR is address of the function
348 the jump pad redirects to. LOCKADDR is the address of the jump
349 pad lock object. ORIG_SIZE is the size in bytes of the
350 instruction at TPADDR. JUMP_ENTRY points to the address of the
351 jump pad entry, and on return holds the address past the end of
352 the created jump pad. If a trampoline is created by the function,
353 then TRAMPOLINE and TRAMPOLINE_SIZE return the address and size of
354 the trampoline, else they remain unchanged. JJUMP_PAD_INSN is a
355 buffer containing a copy of the instruction at TPADDR.
356 ADJUST_INSN_ADDR and ADJUST_INSN_ADDR_END are output parameters that
357 return the address range where the instruction at TPADDR was relocated
358 to. If an error occurs, the ERR may be used to pass on an error
360 int (*install_fast_tracepoint_jump_pad
) (CORE_ADDR tpoint
, CORE_ADDR tpaddr
,
364 CORE_ADDR
*jump_entry
,
365 CORE_ADDR
*trampoline
,
366 ULONGEST
*trampoline_size
,
367 unsigned char *jjump_pad_insn
,
368 ULONGEST
*jjump_pad_insn_size
,
369 CORE_ADDR
*adjusted_insn_addr
,
370 CORE_ADDR
*adjusted_insn_addr_end
,
373 /* Return the bytecode operations vector for the current inferior.
374 Returns NULL if bytecode compilation is not supported. */
375 struct emit_ops
*(*emit_ops
) (void);
377 /* Returns true if the target supports disabling randomization. */
378 int (*supports_disable_randomization
) (void);
380 /* Return the minimum length of an instruction that can be safely overwritten
381 for use as a fast tracepoint. */
382 int (*get_min_fast_tracepoint_insn_len
) (void);
384 /* Read solib info on SVR4 platforms. */
385 int (*qxfer_libraries_svr4
) (const char *annex
, unsigned char *readbuf
,
386 unsigned const char *writebuf
,
387 CORE_ADDR offset
, int len
);
389 /* Return true if target supports debugging agent. */
390 int (*supports_agent
) (void);
392 /* Check whether the target supports branch tracing. */
393 int (*supports_btrace
) (struct target_ops
*, enum btrace_format
);
395 /* Enable branch tracing for PTID based on CONF and allocate a branch trace
396 target information struct for reading and for disabling branch trace. */
397 struct btrace_target_info
*(*enable_btrace
)
398 (ptid_t ptid
, const struct btrace_config
*conf
);
400 /* Disable branch tracing.
401 Returns zero on success, non-zero otherwise. */
402 int (*disable_btrace
) (struct btrace_target_info
*tinfo
);
404 /* Read branch trace data into buffer.
405 Return 0 on success; print an error message into BUFFER and return -1,
407 int (*read_btrace
) (struct btrace_target_info
*, struct buffer
*,
408 enum btrace_read_type type
);
410 /* Read the branch trace configuration into BUFFER.
411 Return 0 on success; print an error message into BUFFER and return -1
413 int (*read_btrace_conf
) (const struct btrace_target_info
*, struct buffer
*);
415 /* Return true if target supports range stepping. */
416 int (*supports_range_stepping
) (void);
418 /* Return the full absolute name of the executable file that was
419 run to create the process PID. If the executable file cannot
420 be determined, NULL is returned. Otherwise, a pointer to a
421 character string containing the pathname is returned. This
422 string should be copied into a buffer by the client if the string
423 will not be immediately used, or if it must persist. */
424 char *(*pid_to_exec_file
) (int pid
);
426 /* Multiple-filesystem-aware open. Like open(2), but operating in
427 the filesystem as it appears to process PID. Systems where all
428 processes share a common filesystem should set this to NULL.
429 If NULL, the caller should fall back to open(2). */
430 int (*multifs_open
) (int pid
, const char *filename
,
431 int flags
, mode_t mode
);
433 /* Multiple-filesystem-aware unlink. Like unlink(2), but operates
434 in the filesystem as it appears to process PID. Systems where
435 all processes share a common filesystem should set this to NULL.
436 If NULL, the caller should fall back to unlink(2). */
437 int (*multifs_unlink
) (int pid
, const char *filename
);
439 /* Multiple-filesystem-aware readlink. Like readlink(2), but
440 operating in the filesystem as it appears to process PID.
441 Systems where all processes share a common filesystem should
442 set this to NULL. If NULL, the caller should fall back to
444 ssize_t (*multifs_readlink
) (int pid
, const char *filename
,
445 char *buf
, size_t bufsiz
);
447 /* Return the breakpoint kind for this target based on PC. The PCPTR is
448 adjusted to the real memory location in case a flag (e.g., the Thumb bit on
449 ARM) was present in the PC. */
450 int (*breakpoint_kind_from_pc
) (CORE_ADDR
*pcptr
);
452 /* Return the software breakpoint from KIND. KIND can have target
453 specific meaning like the Z0 kind parameter.
454 SIZE is set to the software breakpoint's length in memory. */
455 const gdb_byte
*(*sw_breakpoint_from_kind
) (int kind
, int *size
);
457 /* Return the thread's name, or NULL if the target is unable to determine it.
458 The returned value must not be freed by the caller. */
459 const char *(*thread_name
) (ptid_t thread
);
462 extern struct target_ops
*the_target
;
464 void set_target_ops (struct target_ops
*);
466 #define create_inferior(program, args) \
467 (*the_target->create_inferior) (program, args)
469 #define target_arch_setup() \
472 if (the_target->arch_setup != NULL) \
473 (*the_target->arch_setup) (); \
476 #define myattach(pid) \
477 (*the_target->attach) (pid)
479 int kill_inferior (int);
481 #define target_supports_fork_events() \
482 (the_target->supports_fork_events ? \
483 (*the_target->supports_fork_events) () : 0)
485 #define target_supports_vfork_events() \
486 (the_target->supports_vfork_events ? \
487 (*the_target->supports_vfork_events) () : 0)
489 #define target_supports_exec_events() \
490 (the_target->supports_exec_events ? \
491 (*the_target->supports_exec_events) () : 0)
493 #define target_handle_new_gdb_connection() \
496 if (the_target->handle_new_gdb_connection != NULL) \
497 (*the_target->handle_new_gdb_connection) (); \
500 #define detach_inferior(pid) \
501 (*the_target->detach) (pid)
503 #define mourn_inferior(PROC) \
504 (*the_target->mourn) (PROC)
506 #define mythread_alive(pid) \
507 (*the_target->thread_alive) (pid)
509 #define fetch_inferior_registers(regcache, regno) \
510 (*the_target->fetch_registers) (regcache, regno)
512 #define store_inferior_registers(regcache, regno) \
513 (*the_target->store_registers) (regcache, regno)
515 #define join_inferior(pid) \
516 (*the_target->join) (pid)
518 #define target_supports_non_stop() \
519 (the_target->supports_non_stop ? (*the_target->supports_non_stop ) () : 0)
521 #define target_async(enable) \
522 (the_target->async ? (*the_target->async) (enable) : 0)
524 #define target_supports_multi_process() \
525 (the_target->supports_multi_process ? \
526 (*the_target->supports_multi_process) () : 0)
528 #define target_process_qsupported(features, count) \
531 if (the_target->process_qsupported) \
532 the_target->process_qsupported (features, count); \
535 #define target_supports_tracepoints() \
536 (the_target->supports_tracepoints \
537 ? (*the_target->supports_tracepoints) () : 0)
539 #define target_supports_fast_tracepoints() \
540 (the_target->install_fast_tracepoint_jump_pad != NULL)
542 #define target_get_min_fast_tracepoint_insn_len() \
543 (the_target->get_min_fast_tracepoint_insn_len \
544 ? (*the_target->get_min_fast_tracepoint_insn_len) () : 0)
546 #define thread_stopped(thread) \
547 (*the_target->thread_stopped) (thread)
549 #define pause_all(freeze) \
552 if (the_target->pause_all) \
553 (*the_target->pause_all) (freeze); \
556 #define unpause_all(unfreeze) \
559 if (the_target->unpause_all) \
560 (*the_target->unpause_all) (unfreeze); \
563 #define stabilize_threads() \
566 if (the_target->stabilize_threads) \
567 (*the_target->stabilize_threads) (); \
570 #define install_fast_tracepoint_jump_pad(tpoint, tpaddr, \
571 collector, lockaddr, \
574 trampoline, trampoline_size, \
576 jjump_pad_insn_size, \
577 adjusted_insn_addr, \
578 adjusted_insn_addr_end, \
580 (*the_target->install_fast_tracepoint_jump_pad) (tpoint, tpaddr, \
581 collector,lockaddr, \
582 orig_size, jump_entry, \
586 jjump_pad_insn_size, \
587 adjusted_insn_addr, \
588 adjusted_insn_addr_end, \
591 #define target_emit_ops() \
592 (the_target->emit_ops ? (*the_target->emit_ops) () : NULL)
594 #define target_supports_disable_randomization() \
595 (the_target->supports_disable_randomization ? \
596 (*the_target->supports_disable_randomization) () : 0)
598 #define target_supports_agent() \
599 (the_target->supports_agent ? \
600 (*the_target->supports_agent) () : 0)
602 #define target_supports_btrace(format) \
603 (the_target->supports_btrace \
604 ? (*the_target->supports_btrace) (the_target, format) : 0)
606 #define target_enable_btrace(ptid, conf) \
607 (*the_target->enable_btrace) (ptid, conf)
609 #define target_disable_btrace(tinfo) \
610 (*the_target->disable_btrace) (tinfo)
612 #define target_read_btrace(tinfo, buffer, type) \
613 (*the_target->read_btrace) (tinfo, buffer, type)
615 #define target_read_btrace_conf(tinfo, buffer) \
616 (*the_target->read_btrace_conf) (tinfo, buffer)
618 #define target_supports_range_stepping() \
619 (the_target->supports_range_stepping ? \
620 (*the_target->supports_range_stepping) () : 0)
622 #define target_supports_stopped_by_sw_breakpoint() \
623 (the_target->supports_stopped_by_sw_breakpoint ? \
624 (*the_target->supports_stopped_by_sw_breakpoint) () : 0)
626 #define target_stopped_by_sw_breakpoint() \
627 (the_target->stopped_by_sw_breakpoint ? \
628 (*the_target->stopped_by_sw_breakpoint) () : 0)
630 #define target_supports_stopped_by_hw_breakpoint() \
631 (the_target->supports_stopped_by_hw_breakpoint ? \
632 (*the_target->supports_stopped_by_hw_breakpoint) () : 0)
634 #define target_supports_hardware_single_step() \
635 (the_target->supports_hardware_single_step ? \
636 (*the_target->supports_hardware_single_step) () : 0)
638 #define target_stopped_by_hw_breakpoint() \
639 (the_target->stopped_by_hw_breakpoint ? \
640 (*the_target->stopped_by_hw_breakpoint) () : 0)
642 #define target_breakpoint_kind_from_pc(pcptr) \
643 (the_target->breakpoint_kind_from_pc \
644 ? (*the_target->breakpoint_kind_from_pc) (pcptr) \
645 : default_breakpoint_kind_from_pc (pcptr))
647 /* Start non-stop mode, returns 0 on success, -1 on failure. */
649 int start_non_stop (int nonstop
);
651 ptid_t
mywait (ptid_t ptid
, struct target_waitstatus
*ourstatus
, int options
,
654 /* Prepare to read or write memory from the inferior process. See the
655 corresponding target_ops methods for more details. */
657 int prepare_to_access_memory (void);
658 void done_accessing_memory (void);
660 #define target_core_of_thread(ptid) \
661 (the_target->core_of_thread ? (*the_target->core_of_thread) (ptid) \
664 #define target_thread_name(ptid) \
665 (the_target->thread_name ? (*the_target->thread_name) (ptid) \
668 int read_inferior_memory (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
670 int write_inferior_memory (CORE_ADDR memaddr
, const unsigned char *myaddr
,
673 int set_desired_thread (int id
);
675 const char *target_pid_to_str (ptid_t
);
677 int target_can_do_hardware_single_step (void);
679 int default_breakpoint_kind_from_pc (CORE_ADDR
*pcptr
);
681 #endif /* TARGET_H */