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 /* Attach to a running process.
79 PID is the process ID to attach to, specified by the user
82 Returns -1 if attaching is unsupported, 0 on success, and calls
85 int (*attach
) (unsigned long pid
);
87 /* Kill inferior PID. Return -1 on failure, and 0 on success. */
89 int (*kill
) (int pid
);
91 /* Detach from inferior PID. Return -1 on failure, and 0 on
94 int (*detach
) (int pid
);
96 /* The inferior process has died. Do what is right. */
98 void (*mourn
) (struct process_info
*proc
);
100 /* Wait for inferior PID to exit. */
101 void (*join
) (int pid
);
103 /* Return 1 iff the thread with process ID PID is alive. */
105 int (*thread_alive
) (ptid_t pid
);
107 /* Resume the inferior process. */
109 void (*resume
) (struct thread_resume
*resume_info
, size_t n
);
111 /* Wait for the inferior process or thread to change state. Store
112 status through argument pointer STATUS.
114 PTID = -1 to wait for any pid to do something, PTID(pid,0,0) to
115 wait for any thread of process pid to do something. Return ptid
116 of child, or -1 in case of error; store status through argument
117 pointer STATUS. OPTIONS is a bit set of options defined as
118 TARGET_W* above. If options contains TARGET_WNOHANG and there's
119 no child stop to report, return is
120 null_ptid/TARGET_WAITKIND_IGNORE. */
122 ptid_t (*wait
) (ptid_t ptid
, struct target_waitstatus
*status
, int options
);
124 /* Fetch registers from the inferior process.
126 If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO. */
128 void (*fetch_registers
) (struct regcache
*regcache
, int regno
);
130 /* Store registers to the inferior process.
132 If REGNO is -1, store all registers; otherwise, store at least REGNO. */
134 void (*store_registers
) (struct regcache
*regcache
, int regno
);
136 /* Prepare to read or write memory from the inferior process.
137 Targets use this to do what is necessary to get the state of the
138 inferior such that it is possible to access memory.
140 This should generally only be called from client facing routines,
141 such as gdb_read_memory/gdb_write_memory, or the GDB breakpoint
144 Like `read_memory' and `write_memory' below, returns 0 on success
145 and errno on failure. */
147 int (*prepare_to_access_memory
) (void);
149 /* Undo the effects of prepare_to_access_memory. */
151 void (*done_accessing_memory
) (void);
153 /* Read memory from the inferior process. This should generally be
154 called through read_inferior_memory, which handles breakpoint shadowing.
156 Read LEN bytes at MEMADDR into a buffer at MYADDR.
158 Returns 0 on success and errno on failure. */
160 int (*read_memory
) (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
162 /* Write memory to the inferior process. This should generally be
163 called through write_inferior_memory, which handles breakpoint shadowing.
165 Write LEN bytes from the buffer at MYADDR to MEMADDR.
167 Returns 0 on success and errno on failure. */
169 int (*write_memory
) (CORE_ADDR memaddr
, const unsigned char *myaddr
,
172 /* Query GDB for the values of any symbols we're interested in.
173 This function is called whenever we receive a "qSymbols::"
174 query, which corresponds to every time more symbols (might)
175 become available. NULL if we aren't interested in any
178 void (*look_up_symbols
) (void);
180 /* Send an interrupt request to the inferior process,
181 however is appropriate. */
183 void (*request_interrupt
) (void);
185 /* Read auxiliary vector data from the inferior process.
187 Read LEN bytes at OFFSET into a buffer at MYADDR. */
189 int (*read_auxv
) (CORE_ADDR offset
, unsigned char *myaddr
,
192 /* Returns true if GDB Z breakpoint type TYPE is supported, false
193 otherwise. The type is coded as follows:
194 '0' - software-breakpoint
195 '1' - hardware-breakpoint
196 '2' - write watchpoint
197 '3' - read watchpoint
198 '4' - access watchpoint
200 int (*supports_z_point_type
) (char z_type
);
202 /* Insert and remove a break or watchpoint.
203 Returns 0 on success, -1 on failure and 1 on unsupported. */
205 int (*insert_point
) (enum raw_bkpt_type type
, CORE_ADDR addr
,
206 int size
, struct raw_breakpoint
*bp
);
207 int (*remove_point
) (enum raw_bkpt_type type
, CORE_ADDR addr
,
208 int size
, struct raw_breakpoint
*bp
);
210 /* Returns 1 if the target stopped because it executed a software
211 breakpoint instruction, 0 otherwise. */
212 int (*stopped_by_sw_breakpoint
) (void);
214 /* Returns true if the target knows whether a trap was caused by a
215 SW breakpoint triggering. */
216 int (*supports_stopped_by_sw_breakpoint
) (void);
218 /* Returns 1 if the target stopped for a hardware breakpoint. */
219 int (*stopped_by_hw_breakpoint
) (void);
221 /* Returns true if the target knows whether a trap was caused by a
222 HW breakpoint triggering. */
223 int (*supports_stopped_by_hw_breakpoint
) (void);
225 /* Returns 1 if target was stopped due to a watchpoint hit, 0 otherwise. */
227 int (*stopped_by_watchpoint
) (void);
229 /* Returns the address associated with the watchpoint that hit, if any;
230 returns 0 otherwise. */
232 CORE_ADDR (*stopped_data_address
) (void);
234 /* Reports the text, data offsets of the executable. This is
235 needed for uclinux where the executable is relocated during load
238 int (*read_offsets
) (CORE_ADDR
*text
, CORE_ADDR
*data
);
240 /* Fetch the address associated with a specific thread local storage
241 area, determined by the specified THREAD, OFFSET, and LOAD_MODULE.
242 Stores it in *ADDRESS and returns zero on success; otherwise returns
243 an error code. A return value of -1 means this system does not
244 support the operation. */
246 int (*get_tls_address
) (struct thread_info
*thread
, CORE_ADDR offset
,
247 CORE_ADDR load_module
, CORE_ADDR
*address
);
249 /* Read/Write from/to spufs using qXfer packets. */
250 int (*qxfer_spu
) (const char *annex
, unsigned char *readbuf
,
251 unsigned const char *writebuf
, CORE_ADDR offset
, int len
);
253 /* Fill BUF with an hostio error packet representing the last hostio
255 void (*hostio_last_error
) (char *buf
);
257 /* Read/Write OS data using qXfer packets. */
258 int (*qxfer_osdata
) (const char *annex
, unsigned char *readbuf
,
259 unsigned const char *writebuf
, CORE_ADDR offset
,
262 /* Read/Write extra signal info. */
263 int (*qxfer_siginfo
) (const char *annex
, unsigned char *readbuf
,
264 unsigned const char *writebuf
,
265 CORE_ADDR offset
, int len
);
267 int (*supports_non_stop
) (void);
269 /* Enables async target events. Returns the previous enable
271 int (*async
) (int enable
);
273 /* Switch to non-stop (1) or all-stop (0) mode. Return 0 on
274 success, -1 otherwise. */
275 int (*start_non_stop
) (int);
277 /* Returns true if the target supports multi-process debugging. */
278 int (*supports_multi_process
) (void);
280 /* If not NULL, target-specific routine to process monitor command.
281 Returns 1 if handled, or 0 to perform default processing. */
282 int (*handle_monitor_command
) (char *);
284 /* Returns the core given a thread, or -1 if not known. */
285 int (*core_of_thread
) (ptid_t
);
287 /* Read loadmaps. Read LEN bytes at OFFSET into a buffer at MYADDR. */
288 int (*read_loadmap
) (const char *annex
, CORE_ADDR offset
,
289 unsigned char *myaddr
, unsigned int len
);
291 /* Target specific qSupported support. */
292 void (*process_qsupported
) (const char *);
294 /* Return 1 if the target supports tracepoints, 0 (or leave the
295 callback NULL) otherwise. */
296 int (*supports_tracepoints
) (void);
298 /* Read PC from REGCACHE. */
299 CORE_ADDR (*read_pc
) (struct regcache
*regcache
);
301 /* Write PC to REGCACHE. */
302 void (*write_pc
) (struct regcache
*regcache
, CORE_ADDR pc
);
304 /* Return true if THREAD is known to be stopped now. */
305 int (*thread_stopped
) (struct thread_info
*thread
);
307 /* Read Thread Information Block address. */
308 int (*get_tib_address
) (ptid_t ptid
, CORE_ADDR
*address
);
310 /* Pause all threads. If FREEZE, arrange for any resume attempt to
311 be ignored until an unpause_all call unfreezes threads again.
312 There can be nested calls to pause_all, so a freeze counter
313 should be maintained. */
314 void (*pause_all
) (int freeze
);
316 /* Unpause all threads. Threads that hadn't been resumed by the
317 client should be left stopped. Basically a pause/unpause call
318 pair should not end up resuming threads that were stopped before
320 void (*unpause_all
) (int unfreeze
);
322 /* Stabilize all threads. That is, force them out of jump pads. */
323 void (*stabilize_threads
) (void);
325 /* Install a fast tracepoint jump pad. TPOINT is the address of the
326 tracepoint internal object as used by the IPA agent. TPADDR is
327 the address of tracepoint. COLLECTOR is address of the function
328 the jump pad redirects to. LOCKADDR is the address of the jump
329 pad lock object. ORIG_SIZE is the size in bytes of the
330 instruction at TPADDR. JUMP_ENTRY points to the address of the
331 jump pad entry, and on return holds the address past the end of
332 the created jump pad. If a trampoline is created by the function,
333 then TRAMPOLINE and TRAMPOLINE_SIZE return the address and size of
334 the trampoline, else they remain unchanged. JJUMP_PAD_INSN is a
335 buffer containing a copy of the instruction at TPADDR.
336 ADJUST_INSN_ADDR and ADJUST_INSN_ADDR_END are output parameters that
337 return the address range where the instruction at TPADDR was relocated
338 to. If an error occurs, the ERR may be used to pass on an error
340 int (*install_fast_tracepoint_jump_pad
) (CORE_ADDR tpoint
, CORE_ADDR tpaddr
,
344 CORE_ADDR
*jump_entry
,
345 CORE_ADDR
*trampoline
,
346 ULONGEST
*trampoline_size
,
347 unsigned char *jjump_pad_insn
,
348 ULONGEST
*jjump_pad_insn_size
,
349 CORE_ADDR
*adjusted_insn_addr
,
350 CORE_ADDR
*adjusted_insn_addr_end
,
353 /* Return the bytecode operations vector for the current inferior.
354 Returns NULL if bytecode compilation is not supported. */
355 struct emit_ops
*(*emit_ops
) (void);
357 /* Returns true if the target supports disabling randomization. */
358 int (*supports_disable_randomization
) (void);
360 /* Return the minimum length of an instruction that can be safely overwritten
361 for use as a fast tracepoint. */
362 int (*get_min_fast_tracepoint_insn_len
) (void);
364 /* Read solib info on SVR4 platforms. */
365 int (*qxfer_libraries_svr4
) (const char *annex
, unsigned char *readbuf
,
366 unsigned const char *writebuf
,
367 CORE_ADDR offset
, int len
);
369 /* Return true if target supports debugging agent. */
370 int (*supports_agent
) (void);
372 /* Check whether the target supports branch tracing. */
373 int (*supports_btrace
) (struct target_ops
*, enum btrace_format
);
375 /* Enable branch tracing for PTID based on CONF and allocate a branch trace
376 target information struct for reading and for disabling branch trace. */
377 struct btrace_target_info
*(*enable_btrace
)
378 (ptid_t ptid
, const struct btrace_config
*conf
);
380 /* Disable branch tracing.
381 Returns zero on success, non-zero otherwise. */
382 int (*disable_btrace
) (struct btrace_target_info
*tinfo
);
384 /* Read branch trace data into buffer. We use an int to specify the type
385 to break a cyclic dependency.
386 Return 0 on success; print an error message into BUFFER and return -1,
388 int (*read_btrace
) (struct btrace_target_info
*, struct buffer
*, int type
);
390 /* Read the branch trace configuration into BUFFER.
391 Return 0 on success; print an error message into BUFFER and return -1
393 int (*read_btrace_conf
) (const struct btrace_target_info
*, struct buffer
*);
395 /* Return true if target supports range stepping. */
396 int (*supports_range_stepping
) (void);
399 extern struct target_ops
*the_target
;
401 void set_target_ops (struct target_ops
*);
403 #define create_inferior(program, args) \
404 (*the_target->create_inferior) (program, args)
406 #define myattach(pid) \
407 (*the_target->attach) (pid)
409 int kill_inferior (int);
411 #define detach_inferior(pid) \
412 (*the_target->detach) (pid)
414 #define mourn_inferior(PROC) \
415 (*the_target->mourn) (PROC)
417 #define mythread_alive(pid) \
418 (*the_target->thread_alive) (pid)
420 #define fetch_inferior_registers(regcache, regno) \
421 (*the_target->fetch_registers) (regcache, regno)
423 #define store_inferior_registers(regcache, regno) \
424 (*the_target->store_registers) (regcache, regno)
426 #define join_inferior(pid) \
427 (*the_target->join) (pid)
429 #define target_supports_non_stop() \
430 (the_target->supports_non_stop ? (*the_target->supports_non_stop ) () : 0)
432 #define target_async(enable) \
433 (the_target->async ? (*the_target->async) (enable) : 0)
435 #define target_supports_multi_process() \
436 (the_target->supports_multi_process ? \
437 (*the_target->supports_multi_process) () : 0)
439 #define target_process_qsupported(query) \
442 if (the_target->process_qsupported) \
443 the_target->process_qsupported (query); \
446 #define target_supports_tracepoints() \
447 (the_target->supports_tracepoints \
448 ? (*the_target->supports_tracepoints) () : 0)
450 #define target_supports_fast_tracepoints() \
451 (the_target->install_fast_tracepoint_jump_pad != NULL)
453 #define target_get_min_fast_tracepoint_insn_len() \
454 (the_target->get_min_fast_tracepoint_insn_len \
455 ? (*the_target->get_min_fast_tracepoint_insn_len) () : 0)
457 #define thread_stopped(thread) \
458 (*the_target->thread_stopped) (thread)
460 #define pause_all(freeze) \
463 if (the_target->pause_all) \
464 (*the_target->pause_all) (freeze); \
467 #define unpause_all(unfreeze) \
470 if (the_target->unpause_all) \
471 (*the_target->unpause_all) (unfreeze); \
474 #define stabilize_threads() \
477 if (the_target->stabilize_threads) \
478 (*the_target->stabilize_threads) (); \
481 #define install_fast_tracepoint_jump_pad(tpoint, tpaddr, \
482 collector, lockaddr, \
485 trampoline, trampoline_size, \
487 jjump_pad_insn_size, \
488 adjusted_insn_addr, \
489 adjusted_insn_addr_end, \
491 (*the_target->install_fast_tracepoint_jump_pad) (tpoint, tpaddr, \
492 collector,lockaddr, \
493 orig_size, jump_entry, \
497 jjump_pad_insn_size, \
498 adjusted_insn_addr, \
499 adjusted_insn_addr_end, \
502 #define target_emit_ops() \
503 (the_target->emit_ops ? (*the_target->emit_ops) () : NULL)
505 #define target_supports_disable_randomization() \
506 (the_target->supports_disable_randomization ? \
507 (*the_target->supports_disable_randomization) () : 0)
509 #define target_supports_agent() \
510 (the_target->supports_agent ? \
511 (*the_target->supports_agent) () : 0)
513 #define target_supports_btrace(format) \
514 (the_target->supports_btrace \
515 ? (*the_target->supports_btrace) (the_target, format) : 0)
517 #define target_enable_btrace(ptid, conf) \
518 (*the_target->enable_btrace) (ptid, conf)
520 #define target_disable_btrace(tinfo) \
521 (*the_target->disable_btrace) (tinfo)
523 #define target_read_btrace(tinfo, buffer, type) \
524 (*the_target->read_btrace) (tinfo, buffer, type)
526 #define target_read_btrace_conf(tinfo, buffer) \
527 (*the_target->read_btrace_conf) (tinfo, buffer)
529 #define target_supports_range_stepping() \
530 (the_target->supports_range_stepping ? \
531 (*the_target->supports_range_stepping) () : 0)
533 #define target_supports_stopped_by_sw_breakpoint() \
534 (the_target->supports_stopped_by_sw_breakpoint ? \
535 (*the_target->supports_stopped_by_sw_breakpoint) () : 0)
537 #define target_stopped_by_sw_breakpoint() \
538 (the_target->stopped_by_sw_breakpoint ? \
539 (*the_target->stopped_by_sw_breakpoint) () : 0)
541 #define target_supports_stopped_by_hw_breakpoint() \
542 (the_target->supports_stopped_by_hw_breakpoint ? \
543 (*the_target->supports_stopped_by_hw_breakpoint) () : 0)
545 #define target_stopped_by_hw_breakpoint() \
546 (the_target->stopped_by_hw_breakpoint ? \
547 (*the_target->stopped_by_hw_breakpoint) () : 0)
549 /* Start non-stop mode, returns 0 on success, -1 on failure. */
551 int start_non_stop (int nonstop
);
553 ptid_t
mywait (ptid_t ptid
, struct target_waitstatus
*ourstatus
, int options
,
556 #define prepare_to_access_memory() \
557 (the_target->prepare_to_access_memory \
558 ? (*the_target->prepare_to_access_memory) () \
561 #define done_accessing_memory() \
564 if (the_target->done_accessing_memory) \
565 (*the_target->done_accessing_memory) (); \
568 #define target_core_of_thread(ptid) \
569 (the_target->core_of_thread ? (*the_target->core_of_thread) (ptid) \
572 int read_inferior_memory (CORE_ADDR memaddr
, unsigned char *myaddr
, int len
);
574 int write_inferior_memory (CORE_ADDR memaddr
, const unsigned char *myaddr
,
577 void set_desired_thread (int id
);
579 const char *target_pid_to_str (ptid_t
);
581 #endif /* TARGET_H */