1 /* Target operations for the remote server for GDB.
2 Copyright (C) 2002-2020 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/>. */
21 #ifndef GDBSERVER_TARGET_H
22 #define GDBSERVER_TARGET_H
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 "gdbsupport/btrace-common.h"
37 /* This structure describes how to resume a particular thread (or all
38 threads) based on the client's request. If thread is -1, then this
39 entry applies to all threads. These are passed around as an
46 /* How to "resume". */
47 enum resume_kind kind
;
49 /* If non-zero, send this signal when we resume, or to stop the
50 thread. If stopping a thread, and this is 0, the target should
51 stop the thread however it best decides to (e.g., SIGSTOP on
52 linux; SuspendThread on win32). This is a host signal value (not
56 /* Range to single step within. Valid only iff KIND is resume_step.
58 Single-step once, and then continuing stepping as long as the
59 thread stops in this range. (If the range is empty
60 [STEP_RANGE_START == STEP_RANGE_END], then this is a single-step
62 CORE_ADDR step_range_start
; /* Inclusive */
63 CORE_ADDR step_range_end
; /* Exclusive */
66 /* GDBserver doesn't have a concept of strata like GDB, but we call
67 its target vector "process_stratum" anyway for the benefit of
70 class process_stratum_target
74 virtual ~process_stratum_target () = default;
76 /* Start a new process.
78 PROGRAM is a path to the program to execute.
79 PROGRAM_ARGS is a standard NULL-terminated array of arguments,
80 to be passed to the inferior as ``argv'' (along with PROGRAM).
82 Returns the new PID on success, -1 on failure. Registers the new
83 process with the process list. */
84 virtual int create_inferior (const char *program
,
85 const std::vector
<char *> &program_args
) = 0;
87 /* Do additional setup after a new process is created, including
88 exec-wrapper completion. */
89 virtual void post_create_inferior ();
91 /* Attach to a running process.
93 PID is the process ID to attach to, specified by the user
96 Returns -1 if attaching is unsupported, 0 on success, and calls
98 virtual int attach (unsigned long pid
) = 0;
100 /* Kill process PROC. Return -1 on failure, and 0 on success. */
101 virtual int kill (process_info
*proc
) = 0;
103 /* Detach from process PROC. Return -1 on failure, and 0 on
105 virtual int detach (process_info
*proc
) = 0;
107 /* The inferior process has died. Do what is right. */
108 virtual void mourn (process_info
*proc
) = 0;
110 /* Wait for process PID to exit. */
111 virtual void join (int pid
) = 0;
113 /* Return true iff the thread with process ID PID is alive. */
114 virtual bool thread_alive (ptid_t pid
) = 0;
116 /* Resume the inferior process. */
117 virtual void resume (thread_resume
*resume_info
, size_t n
) = 0;
119 /* Wait for the inferior process or thread to change state. Store
120 status through argument pointer STATUS.
122 PTID = -1 to wait for any pid to do something, PTID(pid,0,0) to
123 wait for any thread of process pid to do something. Return ptid
124 of child, or -1 in case of error; store status through argument
125 pointer STATUS. OPTIONS is a bit set of options defined as
126 TARGET_W* above. If options contains TARGET_WNOHANG and there's
127 no child stop to report, return is
128 null_ptid/TARGET_WAITKIND_IGNORE. */
129 virtual ptid_t
wait (ptid_t ptid
, target_waitstatus
*status
,
132 /* Fetch registers from the inferior process.
134 If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO. */
135 virtual void fetch_registers (regcache
*regcache
, int regno
) = 0;
137 /* Store registers to the inferior process.
139 If REGNO is -1, store all registers; otherwise, store at least REGNO. */
140 virtual void store_registers (regcache
*regcache
, int regno
) = 0;
142 /* Prepare to read or write memory from the inferior process.
143 Targets use this to do what is necessary to get the state of the
144 inferior such that it is possible to access memory.
146 This should generally only be called from client facing routines,
147 such as gdb_read_memory/gdb_write_memory, or the GDB breakpoint
150 Like `read_memory' and `write_memory' below, returns 0 on success
151 and errno on failure. */
152 virtual int prepare_to_access_memory ();
154 /* Undo the effects of prepare_to_access_memory. */
155 virtual void done_accessing_memory ();
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. */
163 virtual int read_memory (CORE_ADDR memaddr
, unsigned char *myaddr
,
166 /* Write memory to the inferior process. This should generally be
167 called through target_write_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. */
172 virtual 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)
179 virtual void look_up_symbols ();
181 /* Send an interrupt request to the inferior process,
182 however is appropriate. */
183 virtual void request_interrupt () = 0;
185 /* Return true if the read_auxv target op is supported. */
186 virtual bool supports_read_auxv ();
188 /* Read auxiliary vector data from the inferior process.
190 Read LEN bytes at OFFSET into a buffer at MYADDR. */
191 virtual int read_auxv (CORE_ADDR offset
, unsigned char *myaddr
,
194 /* Returns true if GDB Z breakpoint type TYPE is supported, false
195 otherwise. The type is coded as follows:
196 '0' - software-breakpoint
197 '1' - hardware-breakpoint
198 '2' - write watchpoint
199 '3' - read watchpoint
200 '4' - access watchpoint
202 virtual bool supports_z_point_type (char z_type
);
204 /* Insert and remove a break or watchpoint.
205 Returns 0 on success, -1 on failure and 1 on unsupported. */
206 virtual int insert_point (enum raw_bkpt_type type
, CORE_ADDR addr
,
207 int size
, raw_breakpoint
*bp
);
209 virtual int remove_point (enum raw_bkpt_type type
, CORE_ADDR addr
,
210 int size
, raw_breakpoint
*bp
);
212 /* Returns true if the target stopped because it executed a software
213 breakpoint instruction, false otherwise. */
214 virtual bool stopped_by_sw_breakpoint ();
216 /* Returns true if the target knows whether a trap was caused by a
217 SW breakpoint triggering. */
218 virtual bool supports_stopped_by_sw_breakpoint ();
220 /* Returns true if the target stopped for a hardware breakpoint. */
221 virtual bool stopped_by_hw_breakpoint ();
223 /* Returns true if the target knows whether a trap was caused by a
224 HW breakpoint triggering. */
225 virtual bool supports_stopped_by_hw_breakpoint ();
227 /* Returns true if the target can do hardware single step. */
228 virtual bool supports_hardware_single_step ();
230 /* Returns true if target was stopped due to a watchpoint hit, false
232 virtual bool stopped_by_watchpoint ();
234 /* Returns the address associated with the watchpoint that hit, if any;
235 returns 0 otherwise. */
236 virtual CORE_ADDR
stopped_data_address ();
238 /* Return true if the read_offsets target op is supported. */
239 virtual bool supports_read_offsets ();
241 /* Reports the text, data offsets of the executable. This is
242 needed for uclinux where the executable is relocated during load
244 virtual int read_offsets (CORE_ADDR
*text
, CORE_ADDR
*data
);
246 /* Return true if the get_tls_address target op is supported. */
247 virtual bool supports_get_tls_address ();
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. */
254 virtual int get_tls_address (thread_info
*thread
, CORE_ADDR offset
,
255 CORE_ADDR load_module
, CORE_ADDR
*address
);
257 /* Fill BUF with an hostio error packet representing the last hostio
259 virtual void hostio_last_error (char *buf
);
261 /* Return true if the qxfer_osdata target op is supported. */
262 virtual bool supports_qxfer_osdata ();
264 /* Read/Write OS data using qXfer packets. */
265 virtual int qxfer_osdata (const char *annex
, unsigned char *readbuf
,
266 unsigned const char *writebuf
,
267 CORE_ADDR offset
, int len
);
269 /* Return true if the qxfer_siginfo target op is supported. */
270 virtual bool supports_qxfer_siginfo ();
272 /* Read/Write extra signal info. */
273 virtual int qxfer_siginfo (const char *annex
, unsigned char *readbuf
,
274 unsigned const char *writebuf
,
275 CORE_ADDR offset
, int len
);
277 /* Return true if non-stop mode is supported. */
278 virtual bool supports_non_stop ();
280 /* Enables async target events. Returns the previous enable
282 virtual bool async (bool enable
);
284 /* Switch to non-stop (ENABLE == true) or all-stop (ENABLE == false)
285 mode. Return 0 on success, -1 otherwise. */
286 virtual int start_non_stop (bool enable
);
288 /* Returns true if the target supports multi-process debugging. */
289 virtual bool supports_multi_process ();
291 /* Returns true if fork events are supported. */
292 virtual bool supports_fork_events ();
294 /* Returns true if vfork events are supported. */
295 virtual bool supports_vfork_events ();
297 /* Returns true if exec events are supported. */
298 virtual bool supports_exec_events ();
300 /* Allows target to re-initialize connection-specific settings. */
301 virtual void handle_new_gdb_connection ();
303 /* The target-specific routine to process monitor command.
304 Returns 1 if handled, or 0 to perform default processing. */
305 virtual int handle_monitor_command (char *mon
);
307 /* Returns the core given a thread, or -1 if not known. */
308 virtual int core_of_thread (ptid_t ptid
);
310 /* Returns true if the read_loadmap target op is supported. */
311 virtual bool supports_read_loadmap ();
313 /* Read loadmaps. Read LEN bytes at OFFSET into a buffer at MYADDR. */
314 virtual int read_loadmap (const char *annex
, CORE_ADDR offset
,
315 unsigned char *myaddr
, unsigned int len
);
317 /* Target specific qSupported support. FEATURES is an array of
318 features with COUNT elements. */
319 virtual void process_qsupported (char **features
, int count
);
321 /* Return true if the target supports tracepoints, false otherwise. */
322 virtual bool supports_tracepoints ();
324 /* Read PC from REGCACHE. */
325 virtual CORE_ADDR
read_pc (regcache
*regcache
);
327 /* Write PC to REGCACHE. */
328 virtual void write_pc (regcache
*regcache
, CORE_ADDR pc
);
330 /* Return true if the thread_stopped op is supported. */
331 virtual bool supports_thread_stopped ();
333 /* Return true if THREAD is known to be stopped now. */
334 virtual bool thread_stopped (thread_info
*thread
);
336 /* Return true if the get_tib_address op is supported. */
337 virtual bool supports_get_tib_address ();
339 /* Read Thread Information Block address. */
340 virtual int get_tib_address (ptid_t ptid
, CORE_ADDR
*address
);
342 /* Pause all threads. If FREEZE, arrange for any resume attempt to
343 be ignored until an unpause_all call unfreezes threads again.
344 There can be nested calls to pause_all, so a freeze counter
345 should be maintained. */
346 virtual void pause_all (bool freeze
);
348 /* Unpause all threads. Threads that hadn't been resumed by the
349 client should be left stopped. Basically a pause/unpause call
350 pair should not end up resuming threads that were stopped before
352 virtual void unpause_all (bool unfreeze
);
354 /* Stabilize all threads. That is, force them out of jump pads. */
355 virtual void stabilize_threads ();
357 /* Return true if the install_fast_tracepoint_jump_pad op is
359 virtual bool supports_fast_tracepoints ();
361 /* Install a fast tracepoint jump pad. TPOINT is the address of the
362 tracepoint internal object as used by the IPA agent. TPADDR is
363 the address of tracepoint. COLLECTOR is address of the function
364 the jump pad redirects to. LOCKADDR is the address of the jump
365 pad lock object. ORIG_SIZE is the size in bytes of the
366 instruction at TPADDR. JUMP_ENTRY points to the address of the
367 jump pad entry, and on return holds the address past the end of
368 the created jump pad. If a trampoline is created by the function,
369 then TRAMPOLINE and TRAMPOLINE_SIZE return the address and size of
370 the trampoline, else they remain unchanged. JJUMP_PAD_INSN is a
371 buffer containing a copy of the instruction at TPADDR.
372 ADJUST_INSN_ADDR and ADJUST_INSN_ADDR_END are output parameters that
373 return the address range where the instruction at TPADDR was relocated
374 to. If an error occurs, the ERR may be used to pass on an error
376 virtual int install_fast_tracepoint_jump_pad
377 (CORE_ADDR tpoint
, CORE_ADDR tpaddr
, CORE_ADDR collector
,
378 CORE_ADDR lockaddr
, ULONGEST orig_size
, CORE_ADDR
*jump_entry
,
379 CORE_ADDR
*trampoline
, ULONGEST
*trampoline_size
,
380 unsigned char *jjump_pad_insn
, ULONGEST
*jjump_pad_insn_size
,
381 CORE_ADDR
*adjusted_insn_addr
, CORE_ADDR
*adjusted_insn_addr_end
,
384 /* Return the minimum length of an instruction that can be safely
385 overwritten for use as a fast tracepoint. */
386 virtual int get_min_fast_tracepoint_insn_len ();
388 /* Return the bytecode operations vector for the current inferior.
389 Returns nullptr if bytecode compilation is not supported. */
390 virtual struct emit_ops
*emit_ops ();
392 /* Returns true if the target supports disabling randomization. */
393 virtual bool supports_disable_randomization ();
395 /* Return true if the qxfer_libraries_svr4 op is supported. */
396 virtual bool supports_qxfer_libraries_svr4 ();
398 /* Read solib info on SVR4 platforms. */
399 virtual int qxfer_libraries_svr4 (const char *annex
,
400 unsigned char *readbuf
,
401 unsigned const char *writebuf
,
402 CORE_ADDR offset
, int len
);
404 /* Return true if target supports debugging agent. */
405 virtual bool supports_agent ();
407 /* Enable branch tracing for PTID based on CONF and allocate a branch trace
408 target information struct for reading and for disabling branch trace. */
409 virtual btrace_target_info
*enable_btrace (ptid_t ptid
,
410 const btrace_config
*conf
);
412 /* Disable branch tracing.
413 Returns zero on success, non-zero otherwise. */
414 virtual int disable_btrace (btrace_target_info
*tinfo
);
416 /* Read branch trace data into buffer.
417 Return 0 on success; print an error message into BUFFER and return -1,
419 virtual int read_btrace (btrace_target_info
*tinfo
, buffer
*buf
,
420 enum btrace_read_type type
);
422 /* Read the branch trace configuration into BUFFER.
423 Return 0 on success; print an error message into BUFFER and return -1
425 virtual int read_btrace_conf (const btrace_target_info
*tinfo
,
428 /* Return true if target supports range stepping. */
429 virtual bool supports_range_stepping ();
431 /* Return true if the pid_to_exec_file op is supported. */
432 virtual bool supports_pid_to_exec_file ();
434 /* Return the full absolute name of the executable file that was
435 run to create the process PID. If the executable file cannot
436 be determined, NULL is returned. Otherwise, a pointer to a
437 character string containing the pathname is returned. This
438 string should be copied into a buffer by the client if the string
439 will not be immediately used, or if it must persist. */
440 virtual char *pid_to_exec_file (int pid
);
442 /* Return true if any of the multifs ops is supported. */
443 virtual bool supports_multifs ();
445 /* Multiple-filesystem-aware open. Like open(2), but operating in
446 the filesystem as it appears to process PID. Systems where all
447 processes share a common filesystem should not override this.
448 The default behavior is to use open(2). */
449 virtual int multifs_open (int pid
, const char *filename
,
450 int flags
, mode_t mode
);
452 /* Multiple-filesystem-aware unlink. Like unlink(2), but operates
453 in the filesystem as it appears to process PID. Systems where
454 all processes share a common filesystem should not override this.
455 The default behavior is to use unlink(2). */
456 virtual int multifs_unlink (int pid
, const char *filename
);
458 /* Multiple-filesystem-aware readlink. Like readlink(2), but
459 operating in the filesystem as it appears to process PID.
460 Systems where all processes share a common filesystem should
461 not override this. The default behavior is to use readlink(2). */
462 virtual ssize_t
multifs_readlink (int pid
, const char *filename
,
463 char *buf
, size_t bufsiz
);
465 /* Return the breakpoint kind for this target based on PC. The
466 PCPTR is adjusted to the real memory location in case a flag
467 (e.g., the Thumb bit on ARM) was present in the PC. */
468 virtual int breakpoint_kind_from_pc (CORE_ADDR
*pcptr
);
470 /* Return the software breakpoint from KIND. KIND can have target
471 specific meaning like the Z0 kind parameter.
472 SIZE is set to the software breakpoint's length in memory. */
473 virtual const gdb_byte
*sw_breakpoint_from_kind (int kind
, int *size
) = 0;
475 /* Return the breakpoint kind for this target based on the current
476 processor state (e.g. the current instruction mode on ARM) and the
477 PC. The PCPTR is adjusted to the real memory location in case a
478 flag (e.g., the Thumb bit on ARM) is present in the PC. */
479 virtual int breakpoint_kind_from_current_state (CORE_ADDR
*pcptr
);
481 /* Return the thread's name, or NULL if the target is unable to
482 determine it. The returned value must not be freed by the
484 virtual const char *thread_name (ptid_t thread
);
486 /* Thread ID to (numeric) thread handle: Return true on success and
487 false for failure. Return pointer to thread handle via HANDLE
488 and the handle's length via HANDLE_LEN. */
489 virtual bool thread_handle (ptid_t ptid
, gdb_byte
**handle
,
492 /* Returns true if the target can software single step. */
493 virtual bool supports_software_single_step ();
495 /* Return true if the target supports catch syscall. */
496 virtual bool supports_catch_syscall ();
498 /* Return tdesc index for IPA. */
499 virtual int get_ipa_tdesc_idx ();
502 extern process_stratum_target
*the_target
;
504 void set_target_ops (process_stratum_target
*);
506 #define target_create_inferior(program, program_args) \
507 the_target->create_inferior (program, program_args)
509 #define target_post_create_inferior() \
510 the_target->post_create_inferior ()
512 #define myattach(pid) \
513 the_target->attach (pid)
515 int kill_inferior (process_info
*proc
);
517 #define target_supports_fork_events() \
518 the_target->supports_fork_events ()
520 #define target_supports_vfork_events() \
521 the_target->supports_vfork_events ()
523 #define target_supports_exec_events() \
524 the_target->supports_exec_events ()
526 #define target_handle_new_gdb_connection() \
527 the_target->handle_new_gdb_connection ()
529 #define detach_inferior(proc) \
530 the_target->detach (proc)
532 #define mythread_alive(pid) \
533 the_target->thread_alive (pid)
535 #define fetch_inferior_registers(regcache, regno) \
536 the_target->fetch_registers (regcache, regno)
538 #define store_inferior_registers(regcache, regno) \
539 the_target->store_registers (regcache, regno)
541 #define join_inferior(pid) \
542 the_target->join (pid)
544 #define target_supports_non_stop() \
545 the_target->supports_non_stop ()
547 #define target_async(enable) \
548 the_target->async (enable)
550 #define target_process_qsupported(features, count) \
551 the_target->process_qsupported (features, count)
553 #define target_supports_catch_syscall() \
554 the_target->supports_catch_syscall ()
556 #define target_get_ipa_tdesc_idx() \
557 the_target->get_ipa_tdesc_idx ()
559 #define target_supports_tracepoints() \
560 the_target->supports_tracepoints ()
562 #define target_supports_fast_tracepoints() \
563 the_target->supports_fast_tracepoints ()
565 #define target_get_min_fast_tracepoint_insn_len() \
566 the_target->get_min_fast_tracepoint_insn_len ()
568 #define target_thread_stopped(thread) \
569 the_target->thread_stopped (thread)
571 #define target_pause_all(freeze) \
572 the_target->pause_all (freeze)
574 #define target_unpause_all(unfreeze) \
575 the_target->unpause_all (unfreeze)
577 #define target_stabilize_threads() \
578 the_target->stabilize_threads ()
580 #define target_install_fast_tracepoint_jump_pad(tpoint, tpaddr, \
581 collector, lockaddr, \
584 trampoline, trampoline_size, \
586 jjump_pad_insn_size, \
587 adjusted_insn_addr, \
588 adjusted_insn_addr_end, \
590 the_target->install_fast_tracepoint_jump_pad (tpoint, tpaddr, \
591 collector,lockaddr, \
592 orig_size, jump_entry, \
596 jjump_pad_insn_size, \
597 adjusted_insn_addr, \
598 adjusted_insn_addr_end, \
601 #define target_emit_ops() \
602 the_target->emit_ops ()
604 #define target_supports_disable_randomization() \
605 the_target->supports_disable_randomization ()
607 #define target_supports_agent() \
608 the_target->supports_agent ()
610 static inline struct btrace_target_info
*
611 target_enable_btrace (ptid_t ptid
, const struct btrace_config
*conf
)
613 return the_target
->enable_btrace (ptid
, conf
);
617 target_disable_btrace (struct btrace_target_info
*tinfo
)
619 return the_target
->disable_btrace (tinfo
);
623 target_read_btrace (struct btrace_target_info
*tinfo
,
624 struct buffer
*buffer
,
625 enum btrace_read_type type
)
627 return the_target
->read_btrace (tinfo
, buffer
, type
);
631 target_read_btrace_conf (struct btrace_target_info
*tinfo
,
632 struct buffer
*buffer
)
634 return the_target
->read_btrace_conf (tinfo
, buffer
);
637 #define target_supports_range_stepping() \
638 the_target->supports_range_stepping ()
640 #define target_supports_stopped_by_sw_breakpoint() \
641 the_target->supports_stopped_by_sw_breakpoint ()
643 #define target_stopped_by_sw_breakpoint() \
644 the_target->stopped_by_sw_breakpoint ()
646 #define target_supports_stopped_by_hw_breakpoint() \
647 the_target->supports_stopped_by_hw_breakpoint ()
649 #define target_supports_hardware_single_step() \
650 the_target->supports_hardware_single_step ()
652 #define target_stopped_by_hw_breakpoint() \
653 the_target->stopped_by_hw_breakpoint ()
655 #define target_breakpoint_kind_from_pc(pcptr) \
656 the_target->breakpoint_kind_from_pc (pcptr)
658 #define target_breakpoint_kind_from_current_state(pcptr) \
659 the_target->breakpoint_kind_from_current_state (pcptr)
661 #define target_supports_software_single_step() \
662 the_target->supports_software_single_step ()
664 ptid_t
mywait (ptid_t ptid
, struct target_waitstatus
*ourstatus
, int options
,
667 /* Prepare to read or write memory from the inferior process. See the
668 corresponding process_stratum_target methods for more details. */
670 int prepare_to_access_memory (void);
671 void done_accessing_memory (void);
673 #define target_core_of_thread(ptid) \
674 the_target->core_of_thread (ptid)
676 #define target_thread_name(ptid) \
677 the_target->thread_name (ptid)
679 #define target_thread_handle(ptid, handle, handle_len) \
680 the_target->thread_handle (ptid, handle, handle_len)
682 int read_inferior_memory (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
684 int set_desired_thread ();
686 const char *target_pid_to_str (ptid_t
);
688 #endif /* GDBSERVER_TARGET_H */