introduce and use find_target_at
[deliverable/binutils-gdb.git] / gdb / target.h
CommitLineData
c906108c 1/* Interface between GDB and target environments, including files and processes
0088c768 2
ecd75fc8 3 Copyright (C) 1990-2014 Free Software Foundation, Inc.
0088c768 4
c906108c
SS
5 Contributed by Cygnus Support. Written by John Gilmore.
6
c5aa993b 7 This file is part of GDB.
c906108c 8
c5aa993b
JM
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
a9762ec7 11 the Free Software Foundation; either version 3 of the License, or
c5aa993b 12 (at your option) any later version.
c906108c 13
c5aa993b
JM
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.
c906108c 18
c5aa993b 19 You should have received a copy of the GNU General Public License
a9762ec7 20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c
SS
21
22#if !defined (TARGET_H)
23#define TARGET_H
24
da3331ec
AC
25struct objfile;
26struct ui_file;
27struct mem_attrib;
1e3ff5ad 28struct target_ops;
d248b706 29struct bp_location;
8181d85f 30struct bp_target_info;
56be3814 31struct regcache;
07b82ea5 32struct target_section_table;
35b1e5cc 33struct trace_state_variable;
00bf0b85
SS
34struct trace_status;
35struct uploaded_tsv;
36struct uploaded_tp;
0fb4aa4b 37struct static_tracepoint_marker;
b3b9301e 38struct traceframe_info;
0cf6dd15 39struct expression;
2a2f9fe4 40struct dcache_struct;
0cf6dd15 41
c906108c
SS
42/* This include file defines the interface between the main part
43 of the debugger, and the part which is target-specific, or
44 specific to the communications interface between us and the
45 target.
46
2146d243
RM
47 A TARGET is an interface between the debugger and a particular
48 kind of file or process. Targets can be STACKED in STRATA,
c906108c
SS
49 so that more than one target can potentially respond to a request.
50 In particular, memory accesses will walk down the stack of targets
51 until they find a target that is interested in handling that particular
52 address. STRATA are artificial boundaries on the stack, within
53 which particular kinds of targets live. Strata exist so that
54 people don't get confused by pushing e.g. a process target and then
55 a file target, and wondering why they can't see the current values
56 of variables any more (the file target is handling them and they
57 never get to the process target). So when you push a file target,
58 it goes into the file stratum, which is always below the process
59 stratum. */
60
33b60d58
LM
61#include "target/resume.h"
62#include "target/wait.h"
63#include "target/waitstatus.h"
c906108c
SS
64#include "bfd.h"
65#include "symtab.h"
29e57380 66#include "memattr.h"
fd79ecee 67#include "vec.h"
2aecd87f 68#include "gdb_signals.h"
02d27625 69#include "btrace.h"
9852c492 70#include "command.h"
c906108c 71
c5aa993b
JM
72enum strata
73 {
74 dummy_stratum, /* The lowest of the low */
75 file_stratum, /* Executable files, etc */
c0edd9ed 76 process_stratum, /* Executing processes or core dump files */
81e64f55 77 thread_stratum, /* Executing threads */
85e747d2
UW
78 record_stratum, /* Support record debugging */
79 arch_stratum /* Architecture overrides */
c5aa993b 80 };
c906108c 81
c5aa993b
JM
82enum thread_control_capabilities
83 {
0d06e24b
JM
84 tc_none = 0, /* Default: can't control thread execution. */
85 tc_schedlock = 1, /* Can lock the thread scheduler. */
c5aa993b 86 };
c906108c 87
a96d9b2e
SDJ
88/* The structure below stores information about a system call.
89 It is basically used in the "catch syscall" command, and in
90 every function that gives information about a system call.
91
92 It's also good to mention that its fields represent everything
93 that we currently know about a syscall in GDB. */
94struct syscall
95 {
96 /* The syscall number. */
97 int number;
98
99 /* The syscall name. */
100 const char *name;
101 };
102
f00150c9
DE
103/* Return a pretty printed form of target_waitstatus.
104 Space for the result is malloc'd, caller must free. */
105extern char *target_waitstatus_to_string (const struct target_waitstatus *);
106
09826ec5
PA
107/* Return a pretty printed form of TARGET_OPTIONS.
108 Space for the result is malloc'd, caller must free. */
109extern char *target_options_to_string (int target_options);
110
2acceee2 111/* Possible types of events that the inferior handler will have to
0d06e24b 112 deal with. */
2acceee2
JM
113enum inferior_event_type
114 {
2acceee2 115 /* Process a normal inferior event which will result in target_wait
0d06e24b 116 being called. */
2146d243 117 INF_REG_EVENT,
0d06e24b 118 /* We are called because a timer went off. */
2acceee2 119 INF_TIMER,
0d06e24b 120 /* We are called to do stuff after the inferior stops. */
c2d11a7d
JM
121 INF_EXEC_COMPLETE,
122 /* We are called to do some stuff after the inferior stops, but we
123 are expected to reenter the proceed() and
c378eb4e 124 handle_inferior_event() functions. This is used only in case of
0d06e24b 125 'step n' like commands. */
c2d11a7d 126 INF_EXEC_CONTINUE
2acceee2 127 };
c906108c 128\f
13547ab6
DJ
129/* Target objects which can be transfered using target_read,
130 target_write, et cetera. */
1e3ff5ad
AC
131
132enum target_object
133{
1e3ff5ad
AC
134 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
135 TARGET_OBJECT_AVR,
23d964e7
UW
136 /* SPU target specific transfer. See "spu-tdep.c". */
137 TARGET_OBJECT_SPU,
1e3ff5ad 138 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
287a334e 139 TARGET_OBJECT_MEMORY,
cf7a04e8
DJ
140 /* Memory, avoiding GDB's data cache and trusting the executable.
141 Target implementations of to_xfer_partial never need to handle
142 this object, and most callers should not use it. */
143 TARGET_OBJECT_RAW_MEMORY,
4e5d721f
DE
144 /* Memory known to be part of the target's stack. This is cached even
145 if it is not in a region marked as such, since it is known to be
146 "normal" RAM. */
147 TARGET_OBJECT_STACK_MEMORY,
29453a14
YQ
148 /* Memory known to be part of the target code. This is cached even
149 if it is not in a region marked as such. */
150 TARGET_OBJECT_CODE_MEMORY,
287a334e
JJ
151 /* Kernel Unwind Table. See "ia64-tdep.c". */
152 TARGET_OBJECT_UNWIND_TABLE,
2146d243
RM
153 /* Transfer auxilliary vector. */
154 TARGET_OBJECT_AUXV,
baf92889 155 /* StackGhost cookie. See "sparc-tdep.c". */
fd79ecee
DJ
156 TARGET_OBJECT_WCOOKIE,
157 /* Target memory map in XML format. */
158 TARGET_OBJECT_MEMORY_MAP,
a76d924d
DJ
159 /* Flash memory. This object can be used to write contents to
160 a previously erased flash memory. Using it without erasing
161 flash can have unexpected results. Addresses are physical
162 address on target, and not relative to flash start. */
23181151
DJ
163 TARGET_OBJECT_FLASH,
164 /* Available target-specific features, e.g. registers and coprocessors.
165 See "target-descriptions.c". ANNEX should never be empty. */
cfa9d6d9
DJ
166 TARGET_OBJECT_AVAILABLE_FEATURES,
167 /* Currently loaded libraries, in XML format. */
07e059b5 168 TARGET_OBJECT_LIBRARIES,
2268b414
JK
169 /* Currently loaded libraries specific for SVR4 systems, in XML format. */
170 TARGET_OBJECT_LIBRARIES_SVR4,
4d1eb6b4 171 /* Currently loaded libraries specific to AIX systems, in XML format. */
ff99b71b 172 TARGET_OBJECT_LIBRARIES_AIX,
07e059b5 173 /* Get OS specific data. The ANNEX specifies the type (running
113a6f1e
JB
174 processes, etc.). The data being transfered is expected to follow
175 the DTD specified in features/osdata.dtd. */
4aa995e1
PA
176 TARGET_OBJECT_OSDATA,
177 /* Extra signal info. Usually the contents of `siginfo_t' on unix
178 platforms. */
179 TARGET_OBJECT_SIGNAL_INFO,
dc146f7c
VP
180 /* The list of threads that are being debugged. */
181 TARGET_OBJECT_THREADS,
0fb4aa4b
PA
182 /* Collected static trace data. */
183 TARGET_OBJECT_STATIC_TRACE_DATA,
77ca787b
JB
184 /* The HP-UX registers (those that can be obtained or modified by using
185 the TT_LWP_RUREGS/TT_LWP_WUREGS ttrace requests). */
186 TARGET_OBJECT_HPUX_UREGS,
c4de7027
JB
187 /* The HP-UX shared library linkage pointer. ANNEX should be a string
188 image of the code address whose linkage pointer we are looking for.
189
190 The size of the data transfered is always 8 bytes (the size of an
191 address on ia64). */
192 TARGET_OBJECT_HPUX_SOLIB_GOT,
b3b9301e
PA
193 /* Traceframe info, in XML format. */
194 TARGET_OBJECT_TRACEFRAME_INFO,
78d85199
YQ
195 /* Load maps for FDPIC systems. */
196 TARGET_OBJECT_FDPIC,
f00c55f8 197 /* Darwin dynamic linker info data. */
169081d0
TG
198 TARGET_OBJECT_DARWIN_DYLD_INFO,
199 /* OpenVMS Unwind Information Block. */
02d27625 200 TARGET_OBJECT_OPENVMS_UIB,
9accd112
MM
201 /* Branch trace data, in XML format. */
202 TARGET_OBJECT_BTRACE
c378eb4e 203 /* Possible future objects: TARGET_OBJECT_FILE, ... */
1e3ff5ad
AC
204};
205
9b409511 206/* Possible values returned by target_xfer_partial, etc. */
6be7b56e 207
9b409511 208enum target_xfer_status
6be7b56e 209{
9b409511
YQ
210 /* Some bytes are transferred. */
211 TARGET_XFER_OK = 1,
212
213 /* No further transfer is possible. */
214 TARGET_XFER_EOF = 0,
215
6be7b56e
PA
216 /* Generic I/O error. Note that it's important that this is '-1',
217 as we still have target_xfer-related code returning hardcoded
218 '-1' on error. */
219 TARGET_XFER_E_IO = -1,
220
221 /* Transfer failed because the piece of the object requested is
222 unavailable. */
223 TARGET_XFER_E_UNAVAILABLE = -2,
224
225 /* Keep list in sync with target_xfer_error_to_string. */
226};
227
9b409511
YQ
228#define TARGET_XFER_STATUS_ERROR_P(STATUS) ((STATUS) < TARGET_XFER_EOF)
229
6be7b56e
PA
230/* Return the string form of ERR. */
231
9b409511 232extern const char *target_xfer_status_to_string (enum target_xfer_status err);
6be7b56e 233
35b1e5cc
SS
234/* Enumeration of the kinds of traceframe searches that a target may
235 be able to perform. */
236
237enum trace_find_type
238 {
239 tfind_number,
240 tfind_pc,
241 tfind_tp,
242 tfind_range,
243 tfind_outside,
244 };
245
0fb4aa4b
PA
246typedef struct static_tracepoint_marker *static_tracepoint_marker_p;
247DEF_VEC_P(static_tracepoint_marker_p);
248
9b409511 249typedef enum target_xfer_status
4ac248ca
YQ
250 target_xfer_partial_ftype (struct target_ops *ops,
251 enum target_object object,
252 const char *annex,
253 gdb_byte *readbuf,
254 const gdb_byte *writebuf,
255 ULONGEST offset,
9b409511
YQ
256 ULONGEST len,
257 ULONGEST *xfered_len);
4ac248ca 258
13547ab6
DJ
259/* Request that OPS transfer up to LEN 8-bit bytes of the target's
260 OBJECT. The OFFSET, for a seekable object, specifies the
261 starting point. The ANNEX can be used to provide additional
262 data-specific information to the target.
1e3ff5ad 263
578d3588
PA
264 Return the number of bytes actually transfered, or a negative error
265 code (an 'enum target_xfer_error' value) if the transfer is not
266 supported or otherwise fails. Return of a positive value less than
267 LEN indicates that no further transfer is possible. Unlike the raw
268 to_xfer_partial interface, callers of these functions do not need
269 to retry partial transfers. */
1e3ff5ad 270
1e3ff5ad
AC
271extern LONGEST target_read (struct target_ops *ops,
272 enum target_object object,
1b0ba102 273 const char *annex, gdb_byte *buf,
1e3ff5ad
AC
274 ULONGEST offset, LONGEST len);
275
8dedea02
VP
276struct memory_read_result
277 {
c378eb4e 278 /* First address that was read. */
8dedea02
VP
279 ULONGEST begin;
280 /* Past-the-end address. */
281 ULONGEST end;
282 /* The data. */
283 gdb_byte *data;
284};
285typedef struct memory_read_result memory_read_result_s;
286DEF_VEC_O(memory_read_result_s);
287
288extern void free_memory_read_result_vector (void *);
289
290extern VEC(memory_read_result_s)* read_memory_robust (struct target_ops *ops,
291 ULONGEST offset,
292 LONGEST len);
d5086790 293
1e3ff5ad
AC
294extern LONGEST target_write (struct target_ops *ops,
295 enum target_object object,
1b0ba102 296 const char *annex, const gdb_byte *buf,
1e3ff5ad 297 ULONGEST offset, LONGEST len);
b6591e8b 298
a76d924d
DJ
299/* Similar to target_write, except that it also calls PROGRESS with
300 the number of bytes written and the opaque BATON after every
301 successful partial write (and before the first write). This is
302 useful for progress reporting and user interaction while writing
303 data. To abort the transfer, the progress callback can throw an
304 exception. */
305
cf7a04e8
DJ
306LONGEST target_write_with_progress (struct target_ops *ops,
307 enum target_object object,
308 const char *annex, const gdb_byte *buf,
309 ULONGEST offset, LONGEST len,
310 void (*progress) (ULONGEST, void *),
311 void *baton);
312
13547ab6
DJ
313/* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
314 be read using OPS. The return value will be -1 if the transfer
315 fails or is not supported; 0 if the object is empty; or the length
316 of the object otherwise. If a positive value is returned, a
317 sufficiently large buffer will be allocated using xmalloc and
318 returned in *BUF_P containing the contents of the object.
319
320 This method should be used for objects sufficiently small to store
321 in a single xmalloc'd buffer, when no fixed bound on the object's
322 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
323 through this function. */
324
325extern LONGEST target_read_alloc (struct target_ops *ops,
326 enum target_object object,
327 const char *annex, gdb_byte **buf_p);
328
159f81f3
DJ
329/* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
330 returned as a string, allocated using xmalloc. If an error occurs
331 or the transfer is unsupported, NULL is returned. Empty objects
332 are returned as allocated but empty strings. A warning is issued
333 if the result contains any embedded NUL bytes. */
334
335extern char *target_read_stralloc (struct target_ops *ops,
336 enum target_object object,
337 const char *annex);
338
6be7b56e 339/* See target_ops->to_xfer_partial. */
4ac248ca 340extern target_xfer_partial_ftype target_xfer_partial;
6be7b56e 341
b6591e8b
AC
342/* Wrappers to target read/write that perform memory transfers. They
343 throw an error if the memory transfer fails.
344
345 NOTE: cagney/2003-10-23: The naming schema is lifted from
346 "frame.h". The parameter order is lifted from get_frame_memory,
347 which in turn lifted it from read_memory. */
348
349extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
1b0ba102 350 gdb_byte *buf, LONGEST len);
b6591e8b 351extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
e17a4113
UW
352 CORE_ADDR addr, int len,
353 enum bfd_endian byte_order);
1e3ff5ad 354\f
0d06e24b
JM
355struct thread_info; /* fwd decl for parameter list below: */
356
b0a16e66
TT
357/* The type of the callback to the to_async method. */
358
359typedef void async_callback_ftype (enum inferior_event_type event_type,
360 void *context);
361
c906108c 362struct target_ops
c5aa993b 363 {
258b763a 364 struct target_ops *beneath; /* To the target under this one. */
c5aa993b
JM
365 char *to_shortname; /* Name this target type */
366 char *to_longname; /* Name for printing */
367 char *to_doc; /* Documentation. Does not include trailing
c906108c 368 newline, and starts with a one-line descrip-
0d06e24b 369 tion (probably similar to to_longname). */
bba2d28d
AC
370 /* Per-target scratch pad. */
371 void *to_data;
f1c07ab0
AC
372 /* The open routine takes the rest of the parameters from the
373 command, and (if successful) pushes a new target onto the
374 stack. Targets should supply this routine, if only to provide
375 an error message. */
507f3c78 376 void (*to_open) (char *, int);
f1c07ab0
AC
377 /* Old targets with a static target vector provide "to_close".
378 New re-entrant targets provide "to_xclose" and that is expected
379 to xfree everything (including the "struct target_ops"). */
460014f5
JK
380 void (*to_xclose) (struct target_ops *targ);
381 void (*to_close) (void);
136d6dae 382 void (*to_attach) (struct target_ops *ops, char *, int);
507f3c78 383 void (*to_post_attach) (int);
52554a0e 384 void (*to_detach) (struct target_ops *ops, const char *, int);
597320e7 385 void (*to_disconnect) (struct target_ops *, char *, int);
2ea28649 386 void (*to_resume) (struct target_ops *, ptid_t, int, enum gdb_signal);
117de6a9 387 ptid_t (*to_wait) (struct target_ops *,
47608cb1 388 ptid_t, struct target_waitstatus *, int);
28439f5e
PA
389 void (*to_fetch_registers) (struct target_ops *, struct regcache *, int);
390 void (*to_store_registers) (struct target_ops *, struct regcache *, int);
f32dbf8c 391 void (*to_prepare_to_store) (struct target_ops *, struct regcache *);
c5aa993b
JM
392
393 /* Transfer LEN bytes of memory between GDB address MYADDR and
394 target address MEMADDR. If WRITE, transfer them to the target, else
395 transfer them from the target. TARGET is the target from which we
396 get this function.
397
398 Return value, N, is one of the following:
399
400 0 means that we can't handle this. If errno has been set, it is the
401 error which prevented us from doing it (FIXME: What about bfd_error?).
402
403 positive (call it N) means that we have transferred N bytes
404 starting at MEMADDR. We might be able to handle more bytes
405 beyond this length, but no promises.
406
407 negative (call its absolute value N) means that we cannot
408 transfer right at MEMADDR, but we could transfer at least
c8e73a31 409 something at MEMADDR + N.
c5aa993b 410
c8e73a31
AC
411 NOTE: cagney/2004-10-01: This has been entirely superseeded by
412 to_xfer_partial and inferior inheritance. */
413
1b0ba102 414 int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
c8e73a31
AC
415 int len, int write,
416 struct mem_attrib *attrib,
417 struct target_ops *target);
c906108c 418
507f3c78 419 void (*to_files_info) (struct target_ops *);
3db08215
MM
420 int (*to_insert_breakpoint) (struct target_ops *, struct gdbarch *,
421 struct bp_target_info *);
422 int (*to_remove_breakpoint) (struct target_ops *, struct gdbarch *,
423 struct bp_target_info *);
ccaa32c7 424 int (*to_can_use_hw_breakpoint) (int, int, int);
f1310107 425 int (*to_ranged_break_num_registers) (struct target_ops *);
a6d9a66e
UW
426 int (*to_insert_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
427 int (*to_remove_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
0cf6dd15
TJB
428
429 /* Documentation of what the two routines below are expected to do is
430 provided with the corresponding target_* macros. */
431 int (*to_remove_watchpoint) (CORE_ADDR, int, int, struct expression *);
432 int (*to_insert_watchpoint) (CORE_ADDR, int, int, struct expression *);
433
9c06b0b4
TJB
434 int (*to_insert_mask_watchpoint) (struct target_ops *,
435 CORE_ADDR, CORE_ADDR, int);
436 int (*to_remove_mask_watchpoint) (struct target_ops *,
437 CORE_ADDR, CORE_ADDR, int);
6a109b6b 438 int (*to_stopped_by_watchpoint) (struct target_ops *);
74174d2e 439 int to_have_steppable_watchpoint;
7df1a324 440 int to_have_continuable_watchpoint;
4aa7a7f5 441 int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *);
5009afc5
AS
442 int (*to_watchpoint_addr_within_range) (struct target_ops *,
443 CORE_ADDR, CORE_ADDR, int);
e09342b5
TJB
444
445 /* Documentation of this routine is provided with the corresponding
446 target_* macro. */
e0d24f8d 447 int (*to_region_ok_for_hw_watchpoint) (CORE_ADDR, int);
e09342b5 448
0cf6dd15
TJB
449 int (*to_can_accel_watchpoint_condition) (CORE_ADDR, int, int,
450 struct expression *);
9c06b0b4
TJB
451 int (*to_masked_watch_num_registers) (struct target_ops *,
452 CORE_ADDR, CORE_ADDR);
507f3c78
KB
453 void (*to_terminal_init) (void);
454 void (*to_terminal_inferior) (void);
455 void (*to_terminal_ours_for_output) (void);
456 void (*to_terminal_ours) (void);
a790ad35 457 void (*to_terminal_save_ours) (void);
503ebb2c 458 void (*to_terminal_info) (const char *, int);
7d85a9c0 459 void (*to_kill) (struct target_ops *);
507f3c78 460 void (*to_load) (char *, int);
136d6dae
VP
461 void (*to_create_inferior) (struct target_ops *,
462 char *, char *, char **, int);
39f77062 463 void (*to_post_startup_inferior) (ptid_t);
77b06cd7 464 int (*to_insert_fork_catchpoint) (int);
507f3c78 465 int (*to_remove_fork_catchpoint) (int);
77b06cd7 466 int (*to_insert_vfork_catchpoint) (int);
507f3c78 467 int (*to_remove_vfork_catchpoint) (int);
07107ca6 468 int (*to_follow_fork) (struct target_ops *, int, int);
77b06cd7 469 int (*to_insert_exec_catchpoint) (int);
507f3c78 470 int (*to_remove_exec_catchpoint) (int);
a96d9b2e 471 int (*to_set_syscall_catchpoint) (int, int, int, int, int *);
507f3c78 472 int (*to_has_exited) (int, int, int *);
136d6dae 473 void (*to_mourn_inferior) (struct target_ops *);
507f3c78 474 int (*to_can_run) (void);
2455069d
UW
475
476 /* Documentation of this routine is provided with the corresponding
477 target_* macro. */
478 void (*to_pass_signals) (int, unsigned char *);
479
9b224c5e
PA
480 /* Documentation of this routine is provided with the
481 corresponding target_* function. */
482 void (*to_program_signals) (int, unsigned char *);
483
28439f5e
PA
484 int (*to_thread_alive) (struct target_ops *, ptid_t ptid);
485 void (*to_find_new_threads) (struct target_ops *);
117de6a9 486 char *(*to_pid_to_str) (struct target_ops *, ptid_t);
507f3c78 487 char *(*to_extra_thread_info) (struct thread_info *);
4694da01 488 char *(*to_thread_name) (struct thread_info *);
94cc34af 489 void (*to_stop) (ptid_t);
d9fcf2fb 490 void (*to_rcmd) (char *command, struct ui_file *output);
507f3c78 491 char *(*to_pid_to_exec_file) (int pid);
49d03eab 492 void (*to_log_command) (const char *);
07b82ea5 493 struct target_section_table *(*to_get_section_table) (struct target_ops *);
c5aa993b 494 enum strata to_stratum;
c35b1492
PA
495 int (*to_has_all_memory) (struct target_ops *);
496 int (*to_has_memory) (struct target_ops *);
497 int (*to_has_stack) (struct target_ops *);
498 int (*to_has_registers) (struct target_ops *);
aeaec162 499 int (*to_has_execution) (struct target_ops *, ptid_t);
c5aa993b 500 int to_has_thread_control; /* control thread execution */
dc177b7a 501 int to_attach_no_wait;
6426a772 502 /* ASYNC target controls */
6a109b6b
TT
503 int (*to_can_async_p) (struct target_ops *);
504 int (*to_is_async_p) (struct target_ops *);
505 void (*to_async) (struct target_ops *,
506 async_callback_ftype *, void *);
9908b566 507 int (*to_supports_non_stop) (void);
6b04bdb7 508 /* find_memory_regions support method for gcore */
b8edc417 509 int (*to_find_memory_regions) (find_memory_region_ftype func, void *data);
6b04bdb7 510 /* make_corefile_notes support method for gcore */
be4d1333 511 char * (*to_make_corefile_notes) (bfd *, int *);
6b04bdb7
MS
512 /* get_bookmark support method for bookmarks */
513 gdb_byte * (*to_get_bookmark) (char *, int);
514 /* goto_bookmark support method for bookmarks */
515 void (*to_goto_bookmark) (gdb_byte *, int);
3f47be5c
EZ
516 /* Return the thread-local address at OFFSET in the
517 thread-local storage for the thread PTID and the shared library
518 or executable file given by OBJFILE. If that block of
519 thread-local storage hasn't been allocated yet, this function
520 may return an error. */
117de6a9
PA
521 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
522 ptid_t ptid,
b2756930 523 CORE_ADDR load_module_addr,
3f47be5c
EZ
524 CORE_ADDR offset);
525
13547ab6
DJ
526 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
527 OBJECT. The OFFSET, for a seekable object, specifies the
528 starting point. The ANNEX can be used to provide additional
529 data-specific information to the target.
530
9b409511
YQ
531 Return the transferred status, error or OK (an
532 'enum target_xfer_status' value). Save the number of bytes
533 actually transferred in *XFERED_LEN if transfer is successful
534 (TARGET_XFER_OK) or the number unavailable bytes if the requested
535 data is unavailable (TARGET_XFER_E_UNAVAILABLE). *XFERED_LEN
536 smaller than LEN does not indicate the end of the object, only
537 the end of the transfer; higher level code should continue
538 transferring if desired. This is handled in target.c.
13547ab6
DJ
539
540 The interface does not support a "retry" mechanism. Instead it
541 assumes that at least one byte will be transfered on each
542 successful call.
543
544 NOTE: cagney/2003-10-17: The current interface can lead to
545 fragmented transfers. Lower target levels should not implement
546 hacks, such as enlarging the transfer, in an attempt to
547 compensate for this. Instead, the target stack should be
548 extended so that it implements supply/collect methods and a
549 look-aside object cache. With that available, the lowest
550 target can safely and freely "push" data up the stack.
551
552 See target_read and target_write for more information. One,
553 and only one, of readbuf or writebuf must be non-NULL. */
554
9b409511
YQ
555 enum target_xfer_status (*to_xfer_partial) (struct target_ops *ops,
556 enum target_object object,
557 const char *annex,
558 gdb_byte *readbuf,
559 const gdb_byte *writebuf,
560 ULONGEST offset, ULONGEST len,
561 ULONGEST *xfered_len);
1e3ff5ad 562
fd79ecee
DJ
563 /* Returns the memory map for the target. A return value of NULL
564 means that no memory map is available. If a memory address
565 does not fall within any returned regions, it's assumed to be
566 RAM. The returned memory regions should not overlap.
567
568 The order of regions does not matter; target_memory_map will
c378eb4e 569 sort regions by starting address. For that reason, this
fd79ecee
DJ
570 function should not be called directly except via
571 target_memory_map.
572
573 This method should not cache data; if the memory map could
574 change unexpectedly, it should be invalidated, and higher
575 layers will re-fetch it. */
576 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *);
577
a76d924d
DJ
578 /* Erases the region of flash memory starting at ADDRESS, of
579 length LENGTH.
580
581 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
582 on flash block boundaries, as reported by 'to_memory_map'. */
583 void (*to_flash_erase) (struct target_ops *,
584 ULONGEST address, LONGEST length);
585
586 /* Finishes a flash memory write sequence. After this operation
587 all flash memory should be available for writing and the result
588 of reading from areas written by 'to_flash_write' should be
589 equal to what was written. */
590 void (*to_flash_done) (struct target_ops *);
591
424163ea
DJ
592 /* Describe the architecture-specific features of this target.
593 Returns the description found, or NULL if no description
594 was available. */
595 const struct target_desc *(*to_read_description) (struct target_ops *ops);
596
0ef643c8
JB
597 /* Build the PTID of the thread on which a given task is running,
598 based on LWP and THREAD. These values are extracted from the
599 task Private_Data section of the Ada Task Control Block, and
600 their interpretation depends on the target. */
601 ptid_t (*to_get_ada_task_ptid) (long lwp, long thread);
602
c47ffbe3
VP
603 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
604 Return 0 if *READPTR is already at the end of the buffer.
605 Return -1 if there is insufficient buffer for a whole entry.
606 Return 1 if an entry was read into *TYPEP and *VALP. */
607 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
608 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
609
08388c79
DE
610 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
611 sequence of bytes in PATTERN with length PATTERN_LEN.
612
613 The result is 1 if found, 0 if not found, and -1 if there was an error
614 requiring halting of the search (e.g. memory read error).
615 If the pattern is found the address is recorded in FOUND_ADDRP. */
616 int (*to_search_memory) (struct target_ops *ops,
617 CORE_ADDR start_addr, ULONGEST search_space_len,
618 const gdb_byte *pattern, ULONGEST pattern_len,
619 CORE_ADDR *found_addrp);
620
b2175913 621 /* Can target execute in reverse? */
2c0b251b 622 int (*to_can_execute_reverse) (void);
b2175913 623
32231432
PA
624 /* The direction the target is currently executing. Must be
625 implemented on targets that support reverse execution and async
626 mode. The default simply returns forward execution. */
627 enum exec_direction_kind (*to_execution_direction) (void);
628
8a305172
PA
629 /* Does this target support debugging multiple processes
630 simultaneously? */
631 int (*to_supports_multi_process) (void);
632
d248b706
KY
633 /* Does this target support enabling and disabling tracepoints while a trace
634 experiment is running? */
635 int (*to_supports_enable_disable_tracepoint) (void);
636
03583c20
UW
637 /* Does this target support disabling address space randomization? */
638 int (*to_supports_disable_randomization) (void);
639
3065dfb6
SS
640 /* Does this target support the tracenz bytecode for string collection? */
641 int (*to_supports_string_tracing) (void);
642
b775012e
LM
643 /* Does this target support evaluation of breakpoint conditions on its
644 end? */
645 int (*to_supports_evaluation_of_breakpoint_conditions) (void);
646
d3ce09f5
SS
647 /* Does this target support evaluation of breakpoint commands on its
648 end? */
649 int (*to_can_run_breakpoint_commands) (void);
650
3a8f7b07
JK
651 /* Determine current architecture of thread PTID.
652
653 The target is supposed to determine the architecture of the code where
654 the target is currently stopped at (on Cell, if a target is in spu_run,
655 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
656 This is architecture used to perform decr_pc_after_break adjustment,
657 and also determines the frame architecture of the innermost frame.
f5656ead 658 ptrace operations need to operate according to target_gdbarch ().
3a8f7b07 659
f5656ead 660 The default implementation always returns target_gdbarch (). */
c2250ad1
UW
661 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t);
662
c0694254
PA
663 /* Determine current address space of thread PTID.
664
665 The default implementation always returns the inferior's
666 address space. */
667 struct address_space *(*to_thread_address_space) (struct target_ops *,
668 ptid_t);
669
7313baad
UW
670 /* Target file operations. */
671
672 /* Open FILENAME on the target, using FLAGS and MODE. Return a
673 target file descriptor, or -1 if an error occurs (and set
674 *TARGET_ERRNO). */
675 int (*to_fileio_open) (const char *filename, int flags, int mode,
676 int *target_errno);
677
678 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
679 Return the number of bytes written, or -1 if an error occurs
680 (and set *TARGET_ERRNO). */
681 int (*to_fileio_pwrite) (int fd, const gdb_byte *write_buf, int len,
682 ULONGEST offset, int *target_errno);
683
684 /* Read up to LEN bytes FD on the target into READ_BUF.
685 Return the number of bytes read, or -1 if an error occurs
686 (and set *TARGET_ERRNO). */
687 int (*to_fileio_pread) (int fd, gdb_byte *read_buf, int len,
688 ULONGEST offset, int *target_errno);
689
690 /* Close FD on the target. Return 0, or -1 if an error occurs
691 (and set *TARGET_ERRNO). */
692 int (*to_fileio_close) (int fd, int *target_errno);
693
694 /* Unlink FILENAME on the target. Return 0, or -1 if an error
695 occurs (and set *TARGET_ERRNO). */
696 int (*to_fileio_unlink) (const char *filename, int *target_errno);
697
b9e7b9c3
UW
698 /* Read value of symbolic link FILENAME on the target. Return a
699 null-terminated string allocated via xmalloc, or NULL if an error
700 occurs (and set *TARGET_ERRNO). */
701 char *(*to_fileio_readlink) (const char *filename, int *target_errno);
702
7313baad 703
145b16a9
UW
704 /* Implement the "info proc" command. */
705 void (*to_info_proc) (struct target_ops *, char *, enum info_proc_what);
706
35b1e5cc
SS
707 /* Tracepoint-related operations. */
708
709 /* Prepare the target for a tracing run. */
710 void (*to_trace_init) (void);
711
e8ba3115
YQ
712 /* Send full details of a tracepoint location to the target. */
713 void (*to_download_tracepoint) (struct bp_location *location);
35b1e5cc 714
1e4d1764
YQ
715 /* Is the target able to download tracepoint locations in current
716 state? */
717 int (*to_can_download_tracepoint) (void);
718
35b1e5cc
SS
719 /* Send full details of a trace state variable to the target. */
720 void (*to_download_trace_state_variable) (struct trace_state_variable *tsv);
721
d248b706
KY
722 /* Enable a tracepoint on the target. */
723 void (*to_enable_tracepoint) (struct bp_location *location);
724
725 /* Disable a tracepoint on the target. */
726 void (*to_disable_tracepoint) (struct bp_location *location);
727
35b1e5cc
SS
728 /* Inform the target info of memory regions that are readonly
729 (such as text sections), and so it should return data from
730 those rather than look in the trace buffer. */
731 void (*to_trace_set_readonly_regions) (void);
732
733 /* Start a trace run. */
734 void (*to_trace_start) (void);
735
736 /* Get the current status of a tracing run. */
00bf0b85 737 int (*to_get_trace_status) (struct trace_status *ts);
35b1e5cc 738
f196051f
SS
739 void (*to_get_tracepoint_status) (struct breakpoint *tp,
740 struct uploaded_tp *utp);
741
35b1e5cc
SS
742 /* Stop a trace run. */
743 void (*to_trace_stop) (void);
744
745 /* Ask the target to find a trace frame of the given type TYPE,
746 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
747 number of the trace frame, and also the tracepoint number at
c378eb4e 748 TPP. If no trace frame matches, return -1. May throw if the
f197e0f1 749 operation fails. */
35b1e5cc 750 int (*to_trace_find) (enum trace_find_type type, int num,
cc5925ad 751 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp);
35b1e5cc
SS
752
753 /* Get the value of the trace state variable number TSV, returning
754 1 if the value is known and writing the value itself into the
755 location pointed to by VAL, else returning 0. */
756 int (*to_get_trace_state_variable_value) (int tsv, LONGEST *val);
757
011aacb0 758 int (*to_save_trace_data) (const char *filename);
00bf0b85
SS
759
760 int (*to_upload_tracepoints) (struct uploaded_tp **utpp);
761
762 int (*to_upload_trace_state_variables) (struct uploaded_tsv **utsvp);
763
764 LONGEST (*to_get_raw_trace_data) (gdb_byte *buf,
765 ULONGEST offset, LONGEST len);
766
405f8e94
SS
767 /* Get the minimum length of instruction on which a fast tracepoint
768 may be set on the target. If this operation is unsupported,
769 return -1. If for some reason the minimum length cannot be
770 determined, return 0. */
771 int (*to_get_min_fast_tracepoint_insn_len) (void);
772
35b1e5cc
SS
773 /* Set the target's tracing behavior in response to unexpected
774 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
775 void (*to_set_disconnected_tracing) (int val);
4daf5ac0 776 void (*to_set_circular_trace_buffer) (int val);
f6f899bf
HAQ
777 /* Set the size of trace buffer in the target. */
778 void (*to_set_trace_buffer_size) (LONGEST val);
35b1e5cc 779
f196051f
SS
780 /* Add/change textual notes about the trace run, returning 1 if
781 successful, 0 otherwise. */
ca623f82
TT
782 int (*to_set_trace_notes) (const char *user, const char *notes,
783 const char *stopnotes);
f196051f 784
dc146f7c
VP
785 /* Return the processor core that thread PTID was last seen on.
786 This information is updated only when:
787 - update_thread_list is called
788 - thread stops
3e43a32a
MS
789 If the core cannot be determined -- either for the specified
790 thread, or right now, or in this debug session, or for this
791 target -- return -1. */
dc146f7c
VP
792 int (*to_core_of_thread) (struct target_ops *, ptid_t ptid);
793
4a5e7a5b
PA
794 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
795 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
796 a match, 0 if there's a mismatch, and -1 if an error is
797 encountered while reading memory. */
798 int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
799 CORE_ADDR memaddr, ULONGEST size);
800
711e434b
PM
801 /* Return the address of the start of the Thread Information Block
802 a Windows OS specific feature. */
803 int (*to_get_tib_address) (ptid_t ptid, CORE_ADDR *addr);
804
d914c394
SS
805 /* Send the new settings of write permission variables. */
806 void (*to_set_permissions) (void);
807
0fb4aa4b
PA
808 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
809 with its details. Return 1 on success, 0 on failure. */
810 int (*to_static_tracepoint_marker_at) (CORE_ADDR,
811 struct static_tracepoint_marker *marker);
812
813 /* Return a vector of all tracepoints markers string id ID, or all
814 markers if ID is NULL. */
815 VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid)
816 (const char *id);
817
b3b9301e 818 /* Return a traceframe info object describing the current
1527aea8
YQ
819 traceframe's contents. If the target doesn't support
820 traceframe info, return NULL. If the current traceframe is not
821 selected (the current traceframe number is -1), the target can
822 choose to return either NULL or an empty traceframe info. If
823 NULL is returned, for example in remote target, GDB will read
824 from the live inferior. If an empty traceframe info is
825 returned, for example in tfile target, which means the
826 traceframe info is available, but the requested memory is not
827 available in it. GDB will try to see if the requested memory
828 is available in the read-only sections. This method should not
829 cache data; higher layers take care of caching, invalidating,
830 and re-fetching when necessary. */
b3b9301e
PA
831 struct traceframe_info *(*to_traceframe_info) (void);
832
d1feda86
YQ
833 /* Ask the target to use or not to use agent according to USE. Return 1
834 successful, 0 otherwise. */
835 int (*to_use_agent) (int use);
836
837 /* Is the target able to use agent in current state? */
838 int (*to_can_use_agent) (void);
839
02d27625
MM
840 /* Check whether the target supports branch tracing. */
841 int (*to_supports_btrace) (void);
842
843 /* Enable branch tracing for PTID and allocate a branch trace target
844 information struct for reading and for disabling branch trace. */
845 struct btrace_target_info *(*to_enable_btrace) (ptid_t ptid);
846
847 /* Disable branch tracing and deallocate TINFO. */
848 void (*to_disable_btrace) (struct btrace_target_info *tinfo);
849
850 /* Disable branch tracing and deallocate TINFO. This function is similar
851 to to_disable_btrace, except that it is called during teardown and is
852 only allowed to perform actions that are safe. A counter-example would
853 be attempting to talk to a remote target. */
854 void (*to_teardown_btrace) (struct btrace_target_info *tinfo);
855
969c39fb
MM
856 /* Read branch trace data for the thread indicated by BTINFO into DATA.
857 DATA is cleared before new trace is added.
858 The branch trace will start with the most recent block and continue
859 towards older blocks. */
860 enum btrace_error (*to_read_btrace) (VEC (btrace_block_s) **data,
861 struct btrace_target_info *btinfo,
862 enum btrace_read_type type);
02d27625 863
7c1687a9
MM
864 /* Stop trace recording. */
865 void (*to_stop_recording) (void);
866
d02ed0bb
MM
867 /* Print information about the recording. */
868 void (*to_info_record) (void);
869
870 /* Save the recorded execution trace into a file. */
85e1311a 871 void (*to_save_record) (const char *filename);
d02ed0bb
MM
872
873 /* Delete the recorded execution trace from the current position onwards. */
874 void (*to_delete_record) (void);
875
876 /* Query if the record target is currently replaying. */
877 int (*to_record_is_replaying) (void);
878
879 /* Go to the begin of the execution trace. */
880 void (*to_goto_record_begin) (void);
881
882 /* Go to the end of the execution trace. */
883 void (*to_goto_record_end) (void);
884
885 /* Go to a specific location in the recorded execution trace. */
886 void (*to_goto_record) (ULONGEST insn);
887
67c86d06
MM
888 /* Disassemble SIZE instructions in the recorded execution trace from
889 the current position.
890 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
891 disassemble SIZE succeeding instructions. */
892 void (*to_insn_history) (int size, int flags);
893
894 /* Disassemble SIZE instructions in the recorded execution trace around
895 FROM.
896 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
897 disassemble SIZE instructions after FROM. */
898 void (*to_insn_history_from) (ULONGEST from, int size, int flags);
899
900 /* Disassemble a section of the recorded execution trace from instruction
0688d04e 901 BEGIN (inclusive) to instruction END (inclusive). */
67c86d06
MM
902 void (*to_insn_history_range) (ULONGEST begin, ULONGEST end, int flags);
903
15984c13
MM
904 /* Print a function trace of the recorded execution trace.
905 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
906 succeeding functions. */
907 void (*to_call_history) (int size, int flags);
908
909 /* Print a function trace of the recorded execution trace starting
910 at function FROM.
911 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
912 SIZE functions after FROM. */
913 void (*to_call_history_from) (ULONGEST begin, int size, int flags);
914
915 /* Print a function trace of an execution trace section from function BEGIN
0688d04e 916 (inclusive) to function END (inclusive). */
15984c13
MM
917 void (*to_call_history_range) (ULONGEST begin, ULONGEST end, int flags);
918
ced63ec0
GB
919 /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
920 non-empty annex. */
921 int (*to_augmented_libraries_svr4_read) (void);
922
ea001bdc
MM
923 /* Those unwinders are tried before any other arch unwinders. Use NULL if
924 it is not used. */
925 const struct frame_unwind *to_get_unwinder;
926 const struct frame_unwind *to_get_tailcall_unwinder;
927
118e6252
MM
928 /* Return the number of bytes by which the PC needs to be decremented
929 after executing a breakpoint instruction.
930 Defaults to gdbarch_decr_pc_after_break (GDBARCH). */
931 CORE_ADDR (*to_decr_pc_after_break) (struct target_ops *ops,
932 struct gdbarch *gdbarch);
933
c5aa993b 934 int to_magic;
0d06e24b
JM
935 /* Need sub-structure for target machine related rather than comm related?
936 */
c5aa993b 937 };
c906108c
SS
938
939/* Magic number for checking ops size. If a struct doesn't end with this
940 number, somebody changed the declaration but didn't change all the
941 places that initialize one. */
942
943#define OPS_MAGIC 3840
944
945/* The ops structure for our "current" target process. This should
946 never be NULL. If there is no target, it points to the dummy_target. */
947
c5aa993b 948extern struct target_ops current_target;
c906108c 949
c906108c
SS
950/* Define easy words for doing these operations on our current target. */
951
952#define target_shortname (current_target.to_shortname)
953#define target_longname (current_target.to_longname)
954
f1c07ab0 955/* Does whatever cleanup is required for a target that we are no
460014f5
JK
956 longer going to be calling. This routine is automatically always
957 called after popping the target off the target stack - the target's
958 own methods are no longer available through the target vector.
959 Closing file descriptors and freeing all memory allocated memory are
960 typical things it should do. */
f1c07ab0 961
460014f5 962void target_close (struct target_ops *targ);
c906108c
SS
963
964/* Attaches to a process on the target side. Arguments are as passed
965 to the `attach' command by the user. This routine can be called
966 when the target is not on the target-stack, if the target_can_run
2146d243 967 routine returns 1; in that case, it must push itself onto the stack.
c906108c 968 Upon exit, the target should be ready for normal operations, and
2146d243 969 should be ready to deliver the status of the process immediately
c906108c
SS
970 (without waiting) to an upcoming target_wait call. */
971
136d6dae 972void target_attach (char *, int);
c906108c 973
dc177b7a
PA
974/* Some targets don't generate traps when attaching to the inferior,
975 or their target_attach implementation takes care of the waiting.
976 These targets must set to_attach_no_wait. */
977
978#define target_attach_no_wait \
979 (current_target.to_attach_no_wait)
980
c906108c
SS
981/* The target_attach operation places a process under debugger control,
982 and stops the process.
983
984 This operation provides a target-specific hook that allows the
0d06e24b 985 necessary bookkeeping to be performed after an attach completes. */
c906108c 986#define target_post_attach(pid) \
0d06e24b 987 (*current_target.to_post_attach) (pid)
c906108c 988
c906108c
SS
989/* Takes a program previously attached to and detaches it.
990 The program may resume execution (some targets do, some don't) and will
991 no longer stop on signals, etc. We better not have left any breakpoints
992 in the program or it'll die when it hits one. ARGS is arguments
993 typed by the user (e.g. a signal to send the process). FROM_TTY
994 says whether to be verbose or not. */
995
52554a0e 996extern void target_detach (const char *, int);
c906108c 997
6ad8ae5c
DJ
998/* Disconnect from the current target without resuming it (leaving it
999 waiting for a debugger). */
1000
1001extern void target_disconnect (char *, int);
1002
e5ef252a
PA
1003/* Resume execution of the target process PTID (or a group of
1004 threads). STEP says whether to single-step or to run free; SIGGNAL
1005 is the signal to be given to the target, or GDB_SIGNAL_0 for no
1006 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
1007 PTID means `step/resume only this process id'. A wildcard PTID
1008 (all threads, or all threads of process) means `step/resume
1009 INFERIOR_PTID, and let other threads (for which the wildcard PTID
1010 matches) resume with their 'thread->suspend.stop_signal' signal
1011 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1012 if in "no pass" state. */
c906108c 1013
2ea28649 1014extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
c906108c 1015
b5a2688f
AC
1016/* Wait for process pid to do something. PTID = -1 to wait for any
1017 pid to do something. Return pid of child, or -1 in case of error;
c906108c 1018 store status through argument pointer STATUS. Note that it is
b5a2688f 1019 _NOT_ OK to throw_exception() out of target_wait() without popping
c906108c
SS
1020 the debugging target from the stack; GDB isn't prepared to get back
1021 to the prompt with a debugging target but without the frame cache,
47608cb1
PA
1022 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
1023 options. */
c906108c 1024
47608cb1
PA
1025extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
1026 int options);
c906108c 1027
17dee195 1028/* Fetch at least register REGNO, or all regs if regno == -1. No result. */
c906108c 1029
28439f5e 1030extern void target_fetch_registers (struct regcache *regcache, int regno);
c906108c
SS
1031
1032/* Store at least register REGNO, or all regs if REGNO == -1.
1033 It can store as many registers as it wants to, so target_prepare_to_store
1034 must have been previously called. Calls error() if there are problems. */
1035
28439f5e 1036extern void target_store_registers (struct regcache *regcache, int regs);
c906108c
SS
1037
1038/* Get ready to modify the registers array. On machines which store
1039 individual registers, this doesn't need to do anything. On machines
1040 which store all the registers in one fell swoop, this makes sure
1041 that REGISTERS contains all the registers from the program being
1042 debugged. */
1043
316f2060 1044#define target_prepare_to_store(regcache) \
f32dbf8c 1045 (*current_target.to_prepare_to_store) (&current_target, regcache)
c906108c 1046
6c95b8df
PA
1047/* Determine current address space of thread PTID. */
1048
1049struct address_space *target_thread_address_space (ptid_t);
1050
451b7c33
TT
1051/* Implement the "info proc" command. This returns one if the request
1052 was handled, and zero otherwise. It can also throw an exception if
1053 an error was encountered while attempting to handle the
1054 request. */
145b16a9 1055
451b7c33 1056int target_info_proc (char *, enum info_proc_what);
145b16a9 1057
8a305172
PA
1058/* Returns true if this target can debug multiple processes
1059 simultaneously. */
1060
1061#define target_supports_multi_process() \
1062 (*current_target.to_supports_multi_process) ()
1063
03583c20
UW
1064/* Returns true if this target can disable address space randomization. */
1065
1066int target_supports_disable_randomization (void);
1067
d248b706
KY
1068/* Returns true if this target can enable and disable tracepoints
1069 while a trace experiment is running. */
1070
1071#define target_supports_enable_disable_tracepoint() \
1072 (*current_target.to_supports_enable_disable_tracepoint) ()
1073
3065dfb6
SS
1074#define target_supports_string_tracing() \
1075 (*current_target.to_supports_string_tracing) ()
1076
b775012e
LM
1077/* Returns true if this target can handle breakpoint conditions
1078 on its end. */
1079
1080#define target_supports_evaluation_of_breakpoint_conditions() \
1081 (*current_target.to_supports_evaluation_of_breakpoint_conditions) ()
1082
d3ce09f5
SS
1083/* Returns true if this target can handle breakpoint commands
1084 on its end. */
1085
1086#define target_can_run_breakpoint_commands() \
1087 (*current_target.to_can_run_breakpoint_commands) ()
1088
a14ed312 1089extern int target_read_string (CORE_ADDR, char **, int, int *);
c906108c 1090
5299c1c4 1091extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1b162304 1092 ssize_t len);
c906108c 1093
aee4bf85
PA
1094extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1095 ssize_t len);
1096
45aa4659 1097extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
4e5d721f 1098
29453a14
YQ
1099extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1100
fc1a4b47 1101extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
45aa4659 1102 ssize_t len);
c906108c 1103
f0ba3972 1104extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
45aa4659 1105 ssize_t len);
f0ba3972 1106
fd79ecee
DJ
1107/* Fetches the target's memory map. If one is found it is sorted
1108 and returned, after some consistency checking. Otherwise, NULL
1109 is returned. */
1110VEC(mem_region_s) *target_memory_map (void);
1111
a76d924d
DJ
1112/* Erase the specified flash region. */
1113void target_flash_erase (ULONGEST address, LONGEST length);
1114
1115/* Finish a sequence of flash operations. */
1116void target_flash_done (void);
1117
1118/* Describes a request for a memory write operation. */
1119struct memory_write_request
1120 {
c378eb4e 1121 /* Begining address that must be written. */
a76d924d 1122 ULONGEST begin;
c378eb4e 1123 /* Past-the-end address. */
a76d924d 1124 ULONGEST end;
c378eb4e 1125 /* The data to write. */
a76d924d
DJ
1126 gdb_byte *data;
1127 /* A callback baton for progress reporting for this request. */
1128 void *baton;
1129 };
1130typedef struct memory_write_request memory_write_request_s;
1131DEF_VEC_O(memory_write_request_s);
1132
1133/* Enumeration specifying different flash preservation behaviour. */
1134enum flash_preserve_mode
1135 {
1136 flash_preserve,
1137 flash_discard
1138 };
1139
1140/* Write several memory blocks at once. This version can be more
1141 efficient than making several calls to target_write_memory, in
1142 particular because it can optimize accesses to flash memory.
1143
1144 Moreover, this is currently the only memory access function in gdb
1145 that supports writing to flash memory, and it should be used for
1146 all cases where access to flash memory is desirable.
1147
1148 REQUESTS is the vector (see vec.h) of memory_write_request.
1149 PRESERVE_FLASH_P indicates what to do with blocks which must be
1150 erased, but not completely rewritten.
1151 PROGRESS_CB is a function that will be periodically called to provide
1152 feedback to user. It will be called with the baton corresponding
1153 to the request currently being written. It may also be called
1154 with a NULL baton, when preserved flash sectors are being rewritten.
1155
1156 The function returns 0 on success, and error otherwise. */
1157int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1158 enum flash_preserve_mode preserve_flash_p,
1159 void (*progress_cb) (ULONGEST, void *));
1160
c906108c
SS
1161/* Print a line about the current target. */
1162
1163#define target_files_info() \
0d06e24b 1164 (*current_target.to_files_info) (&current_target)
c906108c 1165
3db08215
MM
1166/* Insert a hardware breakpoint at address BP_TGT->placed_address in
1167 the target machine. Returns 0 for success, and returns non-zero or
1168 throws an error (with a detailed failure reason error code and
1169 message) otherwise.
1170 Start the target search at OPS. */
1171
1172extern int forward_target_insert_breakpoint (struct target_ops *ops,
1173 struct gdbarch *gdbarch,
1174 struct bp_target_info *bp_tgt);
1175
0000e5cc
PA
1176/* Insert a hardware breakpoint at address BP_TGT->placed_address in
1177 the target machine. Returns 0 for success, and returns non-zero or
1178 throws an error (with a detailed failure reason error code and
1179 message) otherwise. */
c906108c 1180
d914c394
SS
1181extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1182 struct bp_target_info *bp_tgt);
c906108c 1183
3db08215
MM
1184/* Remove a breakpoint at address BP_TGT->placed_address in the target
1185 machine. Result is 0 for success, non-zero for error.
1186 Start the target search at OPS. */
1187
1188extern int forward_target_remove_breakpoint (struct target_ops *ops,
1189 struct gdbarch *gdbarch,
1190 struct bp_target_info *bp_tgt);
8181d85f 1191/* Remove a breakpoint at address BP_TGT->placed_address in the target
578d3588 1192 machine. Result is 0 for success, non-zero for error. */
c906108c 1193
d914c394
SS
1194extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1195 struct bp_target_info *bp_tgt);
c906108c
SS
1196
1197/* Initialize the terminal settings we record for the inferior,
1198 before we actually run the inferior. */
1199
1200#define target_terminal_init() \
0d06e24b 1201 (*current_target.to_terminal_init) ()
c906108c
SS
1202
1203/* Put the inferior's terminal settings into effect.
1204 This is preparation for starting or resuming the inferior. */
1205
d9d2d8b6 1206extern void target_terminal_inferior (void);
c906108c
SS
1207
1208/* Put some of our terminal settings into effect,
1209 enough to get proper results from our output,
1210 but do not change into or out of RAW mode
1211 so that no input is discarded.
1212
1213 After doing this, either terminal_ours or terminal_inferior
1214 should be called to get back to a normal state of affairs. */
1215
1216#define target_terminal_ours_for_output() \
0d06e24b 1217 (*current_target.to_terminal_ours_for_output) ()
c906108c
SS
1218
1219/* Put our terminal settings into effect.
1220 First record the inferior's terminal settings
1221 so they can be restored properly later. */
1222
1223#define target_terminal_ours() \
0d06e24b 1224 (*current_target.to_terminal_ours) ()
c906108c 1225
a790ad35
SC
1226/* Save our terminal settings.
1227 This is called from TUI after entering or leaving the curses
1228 mode. Since curses modifies our terminal this call is here
1229 to take this change into account. */
1230
1231#define target_terminal_save_ours() \
1232 (*current_target.to_terminal_save_ours) ()
1233
c906108c
SS
1234/* Print useful information about our terminal status, if such a thing
1235 exists. */
1236
1237#define target_terminal_info(arg, from_tty) \
0d06e24b 1238 (*current_target.to_terminal_info) (arg, from_tty)
c906108c
SS
1239
1240/* Kill the inferior process. Make it go away. */
1241
7d85a9c0 1242extern void target_kill (void);
c906108c 1243
0d06e24b
JM
1244/* Load an executable file into the target process. This is expected
1245 to not only bring new code into the target process, but also to
1986bccd
AS
1246 update GDB's symbol tables to match.
1247
1248 ARG contains command-line arguments, to be broken down with
1249 buildargv (). The first non-switch argument is the filename to
1250 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1251 0)), which is an offset to apply to the load addresses of FILE's
1252 sections. The target may define switches, or other non-switch
1253 arguments, as it pleases. */
c906108c 1254
11cf8741 1255extern void target_load (char *arg, int from_tty);
c906108c 1256
39f77062 1257/* Start an inferior process and set inferior_ptid to its pid.
c906108c
SS
1258 EXEC_FILE is the file to run.
1259 ALLARGS is a string containing the arguments to the program.
1260 ENV is the environment vector to pass. Errors reported with error().
1261 On VxWorks and various standalone systems, we ignore exec_file. */
c5aa993b 1262
136d6dae
VP
1263void target_create_inferior (char *exec_file, char *args,
1264 char **env, int from_tty);
c906108c
SS
1265
1266/* Some targets (such as ttrace-based HPUX) don't allow us to request
1267 notification of inferior events such as fork and vork immediately
1268 after the inferior is created. (This because of how gdb gets an
1269 inferior created via invoking a shell to do it. In such a scenario,
1270 if the shell init file has commands in it, the shell will fork and
1271 exec for each of those commands, and we will see each such fork
1272 event. Very bad.)
c5aa993b 1273
0d06e24b
JM
1274 Such targets will supply an appropriate definition for this function. */
1275
39f77062
KB
1276#define target_post_startup_inferior(ptid) \
1277 (*current_target.to_post_startup_inferior) (ptid)
c906108c 1278
0d06e24b
JM
1279/* On some targets, we can catch an inferior fork or vfork event when
1280 it occurs. These functions insert/remove an already-created
77b06cd7
TJB
1281 catchpoint for such events. They return 0 for success, 1 if the
1282 catchpoint type is not supported and -1 for failure. */
c906108c 1283
c906108c 1284#define target_insert_fork_catchpoint(pid) \
0d06e24b 1285 (*current_target.to_insert_fork_catchpoint) (pid)
c906108c
SS
1286
1287#define target_remove_fork_catchpoint(pid) \
0d06e24b 1288 (*current_target.to_remove_fork_catchpoint) (pid)
c906108c
SS
1289
1290#define target_insert_vfork_catchpoint(pid) \
0d06e24b 1291 (*current_target.to_insert_vfork_catchpoint) (pid)
c906108c
SS
1292
1293#define target_remove_vfork_catchpoint(pid) \
0d06e24b 1294 (*current_target.to_remove_vfork_catchpoint) (pid)
c906108c 1295
6604731b
DJ
1296/* If the inferior forks or vforks, this function will be called at
1297 the next resume in order to perform any bookkeeping and fiddling
1298 necessary to continue debugging either the parent or child, as
1299 requested, and releasing the other. Information about the fork
1300 or vfork event is available via get_last_target_status ().
1301 This function returns 1 if the inferior should not be resumed
1302 (i.e. there is another event pending). */
0d06e24b 1303
07107ca6 1304int target_follow_fork (int follow_child, int detach_fork);
c906108c
SS
1305
1306/* On some targets, we can catch an inferior exec event when it
0d06e24b 1307 occurs. These functions insert/remove an already-created
77b06cd7
TJB
1308 catchpoint for such events. They return 0 for success, 1 if the
1309 catchpoint type is not supported and -1 for failure. */
0d06e24b 1310
c906108c 1311#define target_insert_exec_catchpoint(pid) \
0d06e24b 1312 (*current_target.to_insert_exec_catchpoint) (pid)
c5aa993b 1313
c906108c 1314#define target_remove_exec_catchpoint(pid) \
0d06e24b 1315 (*current_target.to_remove_exec_catchpoint) (pid)
c906108c 1316
a96d9b2e
SDJ
1317/* Syscall catch.
1318
1319 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1320 If NEEDED is zero, it means the target can disable the mechanism to
1321 catch system calls because there are no more catchpoints of this type.
1322
1323 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1324 being requested. In this case, both TABLE_SIZE and TABLE should
1325 be ignored.
1326
1327 TABLE_SIZE is the number of elements in TABLE. It only matters if
1328 ANY_COUNT is zero.
1329
1330 TABLE is an array of ints, indexed by syscall number. An element in
1331 this array is nonzero if that syscall should be caught. This argument
77b06cd7
TJB
1332 only matters if ANY_COUNT is zero.
1333
1334 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1335 for failure. */
a96d9b2e
SDJ
1336
1337#define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1338 (*current_target.to_set_syscall_catchpoint) (pid, needed, any_count, \
1339 table_size, table)
1340
c906108c 1341/* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
0d06e24b
JM
1342 exit code of PID, if any. */
1343
c906108c 1344#define target_has_exited(pid,wait_status,exit_status) \
0d06e24b 1345 (*current_target.to_has_exited) (pid,wait_status,exit_status)
c906108c
SS
1346
1347/* The debugger has completed a blocking wait() call. There is now
2146d243 1348 some process event that must be processed. This function should
c906108c 1349 be defined by those targets that require the debugger to perform
0d06e24b 1350 cleanup or internal state changes in response to the process event. */
c906108c
SS
1351
1352/* The inferior process has died. Do what is right. */
1353
136d6dae 1354void target_mourn_inferior (void);
c906108c
SS
1355
1356/* Does target have enough data to do a run or attach command? */
1357
1358#define target_can_run(t) \
0d06e24b 1359 ((t)->to_can_run) ()
c906108c 1360
2455069d
UW
1361/* Set list of signals to be handled in the target.
1362
1363 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
2ea28649 1364 (enum gdb_signal). For every signal whose entry in this array is
2455069d
UW
1365 non-zero, the target is allowed -but not required- to skip reporting
1366 arrival of the signal to the GDB core by returning from target_wait,
1367 and to pass the signal directly to the inferior instead.
1368
1369 However, if the target is hardware single-stepping a thread that is
1370 about to receive a signal, it needs to be reported in any case, even
1371 if mentioned in a previous target_pass_signals call. */
c906108c 1372
2455069d 1373extern void target_pass_signals (int nsig, unsigned char *pass_signals);
c906108c 1374
9b224c5e
PA
1375/* Set list of signals the target may pass to the inferior. This
1376 directly maps to the "handle SIGNAL pass/nopass" setting.
1377
1378 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
2ea28649 1379 number (enum gdb_signal). For every signal whose entry in this
9b224c5e
PA
1380 array is non-zero, the target is allowed to pass the signal to the
1381 inferior. Signals not present in the array shall be silently
1382 discarded. This does not influence whether to pass signals to the
1383 inferior as a result of a target_resume call. This is useful in
1384 scenarios where the target needs to decide whether to pass or not a
1385 signal to the inferior without GDB core involvement, such as for
1386 example, when detaching (as threads may have been suspended with
1387 pending signals not reported to GDB). */
1388
1389extern void target_program_signals (int nsig, unsigned char *program_signals);
1390
c906108c
SS
1391/* Check to see if a thread is still alive. */
1392
28439f5e 1393extern int target_thread_alive (ptid_t ptid);
c906108c 1394
b83266a0
SS
1395/* Query for new threads and add them to the thread list. */
1396
28439f5e 1397extern void target_find_new_threads (void);
b83266a0 1398
0d06e24b
JM
1399/* Make target stop in a continuable fashion. (For instance, under
1400 Unix, this should act like SIGSTOP). This function is normally
1401 used by GUIs to implement a stop button. */
c906108c 1402
d914c394 1403extern void target_stop (ptid_t ptid);
c906108c 1404
96baa820
JM
1405/* Send the specified COMMAND to the target's monitor
1406 (shell,interpreter) for execution. The result of the query is
0d06e24b 1407 placed in OUTBUF. */
96baa820
JM
1408
1409#define target_rcmd(command, outbuf) \
1410 (*current_target.to_rcmd) (command, outbuf)
1411
1412
c906108c
SS
1413/* Does the target include all of memory, or only part of it? This
1414 determines whether we look up the target chain for other parts of
1415 memory if this target can't satisfy a request. */
1416
c35b1492
PA
1417extern int target_has_all_memory_1 (void);
1418#define target_has_all_memory target_has_all_memory_1 ()
c906108c
SS
1419
1420/* Does the target include memory? (Dummy targets don't.) */
1421
c35b1492
PA
1422extern int target_has_memory_1 (void);
1423#define target_has_memory target_has_memory_1 ()
c906108c
SS
1424
1425/* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1426 we start a process.) */
c5aa993b 1427
c35b1492
PA
1428extern int target_has_stack_1 (void);
1429#define target_has_stack target_has_stack_1 ()
c906108c
SS
1430
1431/* Does the target have registers? (Exec files don't.) */
1432
c35b1492
PA
1433extern int target_has_registers_1 (void);
1434#define target_has_registers target_has_registers_1 ()
c906108c
SS
1435
1436/* Does the target have execution? Can we make it jump (through
52bb452f
DJ
1437 hoops), or pop its stack a few times? This means that the current
1438 target is currently executing; for some targets, that's the same as
1439 whether or not the target is capable of execution, but there are
1440 also targets which can be current while not executing. In that
1441 case this will become true after target_create_inferior or
1442 target_attach. */
c906108c 1443
aeaec162
TT
1444extern int target_has_execution_1 (ptid_t);
1445
1446/* Like target_has_execution_1, but always passes inferior_ptid. */
1447
1448extern int target_has_execution_current (void);
1449
1450#define target_has_execution target_has_execution_current ()
c35b1492
PA
1451
1452/* Default implementations for process_stratum targets. Return true
1453 if there's a selected inferior, false otherwise. */
1454
1455extern int default_child_has_all_memory (struct target_ops *ops);
1456extern int default_child_has_memory (struct target_ops *ops);
1457extern int default_child_has_stack (struct target_ops *ops);
1458extern int default_child_has_registers (struct target_ops *ops);
aeaec162
TT
1459extern int default_child_has_execution (struct target_ops *ops,
1460 ptid_t the_ptid);
c906108c
SS
1461
1462/* Can the target support the debugger control of thread execution?
d6350901 1463 Can it lock the thread scheduler? */
c906108c
SS
1464
1465#define target_can_lock_scheduler \
0d06e24b 1466 (current_target.to_has_thread_control & tc_schedlock)
c906108c 1467
c6ebd6cf
VP
1468/* Should the target enable async mode if it is supported? Temporary
1469 cludge until async mode is a strict superset of sync mode. */
1470extern int target_async_permitted;
1471
c378eb4e 1472/* Can the target support asynchronous execution? */
6a109b6b 1473#define target_can_async_p() (current_target.to_can_async_p (&current_target))
6426a772 1474
c378eb4e 1475/* Is the target in asynchronous execution mode? */
6a109b6b 1476#define target_is_async_p() (current_target.to_is_async_p (&current_target))
6426a772 1477
9908b566
VP
1478int target_supports_non_stop (void);
1479
c378eb4e 1480/* Put the target in async mode with the specified callback function. */
0d06e24b 1481#define target_async(CALLBACK,CONTEXT) \
6a109b6b 1482 (current_target.to_async (&current_target, (CALLBACK), (CONTEXT)))
43ff13b4 1483
32231432
PA
1484#define target_execution_direction() \
1485 (current_target.to_execution_direction ())
1486
c906108c
SS
1487/* Converts a process id to a string. Usually, the string just contains
1488 `process xyz', but on some systems it may contain
1489 `process xyz thread abc'. */
1490
117de6a9 1491extern char *target_pid_to_str (ptid_t ptid);
c906108c 1492
39f77062 1493extern char *normal_pid_to_str (ptid_t ptid);
c5aa993b 1494
0d06e24b
JM
1495/* Return a short string describing extra information about PID,
1496 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1497 is okay. */
1498
1499#define target_extra_thread_info(TP) \
1500 (current_target.to_extra_thread_info (TP))
ed9a39eb 1501
4694da01
TT
1502/* Return the thread's name. A NULL result means that the target
1503 could not determine this thread's name. */
1504
1505extern char *target_thread_name (struct thread_info *);
1506
c906108c
SS
1507/* Attempts to find the pathname of the executable file
1508 that was run to create a specified process.
1509
1510 The process PID must be stopped when this operation is used.
c5aa993b 1511
c906108c
SS
1512 If the executable file cannot be determined, NULL is returned.
1513
1514 Else, a pointer to a character string containing the pathname
1515 is returned. This string should be copied into a buffer by
1516 the client if the string will not be immediately used, or if
0d06e24b 1517 it must persist. */
c906108c
SS
1518
1519#define target_pid_to_exec_file(pid) \
0d06e24b 1520 (current_target.to_pid_to_exec_file) (pid)
c906108c 1521
3a8f7b07 1522/* See the to_thread_architecture description in struct target_ops. */
c2250ad1
UW
1523
1524#define target_thread_architecture(ptid) \
1525 (current_target.to_thread_architecture (&current_target, ptid))
1526
be4d1333
MS
1527/*
1528 * Iterator function for target memory regions.
1529 * Calls a callback function once for each memory region 'mapped'
1530 * in the child process. Defined as a simple macro rather than
2146d243 1531 * as a function macro so that it can be tested for nullity.
be4d1333
MS
1532 */
1533
1534#define target_find_memory_regions(FUNC, DATA) \
1535 (current_target.to_find_memory_regions) (FUNC, DATA)
1536
1537/*
1538 * Compose corefile .note section.
1539 */
1540
1541#define target_make_corefile_notes(BFD, SIZE_P) \
1542 (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1543
6b04bdb7
MS
1544/* Bookmark interfaces. */
1545#define target_get_bookmark(ARGS, FROM_TTY) \
1546 (current_target.to_get_bookmark) (ARGS, FROM_TTY)
1547
1548#define target_goto_bookmark(ARG, FROM_TTY) \
1549 (current_target.to_goto_bookmark) (ARG, FROM_TTY)
1550
c906108c
SS
1551/* Hardware watchpoint interfaces. */
1552
1553/* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
7f82dfc7 1554 write). Only the INFERIOR_PTID task is being queried. */
c906108c 1555
6a109b6b
TT
1556#define target_stopped_by_watchpoint() \
1557 ((*current_target.to_stopped_by_watchpoint) (&current_target))
7df1a324 1558
74174d2e
UW
1559/* Non-zero if we have steppable watchpoints */
1560
d92524f1 1561#define target_have_steppable_watchpoint \
74174d2e 1562 (current_target.to_have_steppable_watchpoint)
74174d2e 1563
7df1a324
KW
1564/* Non-zero if we have continuable watchpoints */
1565
d92524f1 1566#define target_have_continuable_watchpoint \
7df1a324 1567 (current_target.to_have_continuable_watchpoint)
c906108c 1568
ccaa32c7 1569/* Provide defaults for hardware watchpoint functions. */
c906108c 1570
2146d243 1571/* If the *_hw_beakpoint functions have not been defined
ccaa32c7 1572 elsewhere use the definitions in the target vector. */
c906108c
SS
1573
1574/* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1575 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1576 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1577 (including this one?). OTHERTYPE is who knows what... */
1578
d92524f1 1579#define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
ccaa32c7 1580 (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
c906108c 1581
e09342b5
TJB
1582/* Returns the number of debug registers needed to watch the given
1583 memory region, or zero if not supported. */
1584
d92524f1 1585#define target_region_ok_for_hw_watchpoint(addr, len) \
e0d24f8d 1586 (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
e0d24f8d 1587
c906108c 1588
85d721b8
PA
1589/* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1590 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
0cf6dd15 1591 COND is the expression for its condition, or NULL if there's none.
85d721b8
PA
1592 Returns 0 for success, 1 if the watchpoint type is not supported,
1593 -1 for failure. */
c906108c 1594
0cf6dd15
TJB
1595#define target_insert_watchpoint(addr, len, type, cond) \
1596 (*current_target.to_insert_watchpoint) (addr, len, type, cond)
c906108c 1597
0cf6dd15
TJB
1598#define target_remove_watchpoint(addr, len, type, cond) \
1599 (*current_target.to_remove_watchpoint) (addr, len, type, cond)
c906108c 1600
9c06b0b4
TJB
1601/* Insert a new masked watchpoint at ADDR using the mask MASK.
1602 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1603 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1604 masked watchpoints are not supported, -1 for failure. */
1605
1606extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1607
1608/* Remove a masked watchpoint at ADDR with the mask MASK.
1609 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1610 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1611 for failure. */
1612
1613extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1614
0000e5cc
PA
1615/* Insert a hardware breakpoint at address BP_TGT->placed_address in
1616 the target machine. Returns 0 for success, and returns non-zero or
1617 throws an error (with a detailed failure reason error code and
1618 message) otherwise. */
1619
a6d9a66e
UW
1620#define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1621 (*current_target.to_insert_hw_breakpoint) (gdbarch, bp_tgt)
ccaa32c7 1622
a6d9a66e
UW
1623#define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1624 (*current_target.to_remove_hw_breakpoint) (gdbarch, bp_tgt)
c906108c 1625
f1310107
TJB
1626/* Return number of debug registers needed for a ranged breakpoint,
1627 or -1 if ranged breakpoints are not supported. */
1628
1629extern int target_ranged_break_num_registers (void);
1630
7f82dfc7
JK
1631/* Return non-zero if target knows the data address which triggered this
1632 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1633 INFERIOR_PTID task is being queried. */
1634#define target_stopped_data_address(target, addr_p) \
1635 (*target.to_stopped_data_address) (target, addr_p)
c906108c 1636
9b3e86b1
MR
1637/* Return non-zero if ADDR is within the range of a watchpoint spanning
1638 LENGTH bytes beginning at START. */
5009afc5
AS
1639#define target_watchpoint_addr_within_range(target, addr, start, length) \
1640 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1641
0cf6dd15
TJB
1642/* Return non-zero if the target is capable of using hardware to evaluate
1643 the condition expression. In this case, if the condition is false when
1644 the watched memory location changes, execution may continue without the
1645 debugger being notified.
1646
1647 Due to limitations in the hardware implementation, it may be capable of
1648 avoiding triggering the watchpoint in some cases where the condition
1649 expression is false, but may report some false positives as well.
1650 For this reason, GDB will still evaluate the condition expression when
1651 the watchpoint triggers. */
1652#define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1653 (*current_target.to_can_accel_watchpoint_condition) (addr, len, type, cond)
1654
9c06b0b4
TJB
1655/* Return number of debug registers needed for a masked watchpoint,
1656 -1 if masked watchpoints are not supported or -2 if the given address
1657 and mask combination cannot be used. */
1658
1659extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1660
b2175913
MS
1661/* Target can execute in reverse? */
1662#define target_can_execute_reverse \
1663 (current_target.to_can_execute_reverse ? \
1664 current_target.to_can_execute_reverse () : 0)
1665
424163ea
DJ
1666extern const struct target_desc *target_read_description (struct target_ops *);
1667
0ef643c8
JB
1668#define target_get_ada_task_ptid(lwp, tid) \
1669 (*current_target.to_get_ada_task_ptid) (lwp,tid)
1670
08388c79
DE
1671/* Utility implementation of searching memory. */
1672extern int simple_search_memory (struct target_ops* ops,
1673 CORE_ADDR start_addr,
1674 ULONGEST search_space_len,
1675 const gdb_byte *pattern,
1676 ULONGEST pattern_len,
1677 CORE_ADDR *found_addrp);
1678
1679/* Main entry point for searching memory. */
1680extern int target_search_memory (CORE_ADDR start_addr,
1681 ULONGEST search_space_len,
1682 const gdb_byte *pattern,
1683 ULONGEST pattern_len,
1684 CORE_ADDR *found_addrp);
1685
7313baad
UW
1686/* Target file operations. */
1687
1688/* Open FILENAME on the target, using FLAGS and MODE. Return a
1689 target file descriptor, or -1 if an error occurs (and set
1690 *TARGET_ERRNO). */
1691extern int target_fileio_open (const char *filename, int flags, int mode,
1692 int *target_errno);
1693
1694/* Write up to LEN bytes from WRITE_BUF to FD on the target.
1695 Return the number of bytes written, or -1 if an error occurs
1696 (and set *TARGET_ERRNO). */
1697extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1698 ULONGEST offset, int *target_errno);
1699
1700/* Read up to LEN bytes FD on the target into READ_BUF.
1701 Return the number of bytes read, or -1 if an error occurs
1702 (and set *TARGET_ERRNO). */
1703extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1704 ULONGEST offset, int *target_errno);
1705
1706/* Close FD on the target. Return 0, or -1 if an error occurs
1707 (and set *TARGET_ERRNO). */
1708extern int target_fileio_close (int fd, int *target_errno);
1709
1710/* Unlink FILENAME on the target. Return 0, or -1 if an error
1711 occurs (and set *TARGET_ERRNO). */
1712extern int target_fileio_unlink (const char *filename, int *target_errno);
1713
b9e7b9c3
UW
1714/* Read value of symbolic link FILENAME on the target. Return a
1715 null-terminated string allocated via xmalloc, or NULL if an error
1716 occurs (and set *TARGET_ERRNO). */
1717extern char *target_fileio_readlink (const char *filename, int *target_errno);
1718
7313baad
UW
1719/* Read target file FILENAME. The return value will be -1 if the transfer
1720 fails or is not supported; 0 if the object is empty; or the length
1721 of the object otherwise. If a positive value is returned, a
1722 sufficiently large buffer will be allocated using xmalloc and
1723 returned in *BUF_P containing the contents of the object.
1724
1725 This method should be used for objects sufficiently small to store
1726 in a single xmalloc'd buffer, when no fixed bound on the object's
1727 size is known in advance. */
1728extern LONGEST target_fileio_read_alloc (const char *filename,
1729 gdb_byte **buf_p);
1730
1731/* Read target file FILENAME. The result is NUL-terminated and
1732 returned as a string, allocated using xmalloc. If an error occurs
1733 or the transfer is unsupported, NULL is returned. Empty objects
1734 are returned as allocated but empty strings. A warning is issued
1735 if the result contains any embedded NUL bytes. */
1736extern char *target_fileio_read_stralloc (const char *filename);
1737
1738
35b1e5cc
SS
1739/* Tracepoint-related operations. */
1740
1741#define target_trace_init() \
1742 (*current_target.to_trace_init) ()
1743
1744#define target_download_tracepoint(t) \
1745 (*current_target.to_download_tracepoint) (t)
1746
1e4d1764
YQ
1747#define target_can_download_tracepoint() \
1748 (*current_target.to_can_download_tracepoint) ()
1749
35b1e5cc
SS
1750#define target_download_trace_state_variable(tsv) \
1751 (*current_target.to_download_trace_state_variable) (tsv)
1752
d248b706
KY
1753#define target_enable_tracepoint(loc) \
1754 (*current_target.to_enable_tracepoint) (loc)
1755
1756#define target_disable_tracepoint(loc) \
1757 (*current_target.to_disable_tracepoint) (loc)
1758
35b1e5cc
SS
1759#define target_trace_start() \
1760 (*current_target.to_trace_start) ()
1761
1762#define target_trace_set_readonly_regions() \
1763 (*current_target.to_trace_set_readonly_regions) ()
1764
00bf0b85
SS
1765#define target_get_trace_status(ts) \
1766 (*current_target.to_get_trace_status) (ts)
35b1e5cc 1767
f196051f
SS
1768#define target_get_tracepoint_status(tp,utp) \
1769 (*current_target.to_get_tracepoint_status) (tp, utp)
1770
35b1e5cc
SS
1771#define target_trace_stop() \
1772 (*current_target.to_trace_stop) ()
1773
1774#define target_trace_find(type,num,addr1,addr2,tpp) \
1775 (*current_target.to_trace_find) ((type), (num), (addr1), (addr2), (tpp))
1776
1777#define target_get_trace_state_variable_value(tsv,val) \
1778 (*current_target.to_get_trace_state_variable_value) ((tsv), (val))
1779
00bf0b85
SS
1780#define target_save_trace_data(filename) \
1781 (*current_target.to_save_trace_data) (filename)
1782
1783#define target_upload_tracepoints(utpp) \
1784 (*current_target.to_upload_tracepoints) (utpp)
1785
1786#define target_upload_trace_state_variables(utsvp) \
1787 (*current_target.to_upload_trace_state_variables) (utsvp)
1788
1789#define target_get_raw_trace_data(buf,offset,len) \
1790 (*current_target.to_get_raw_trace_data) ((buf), (offset), (len))
1791
405f8e94
SS
1792#define target_get_min_fast_tracepoint_insn_len() \
1793 (*current_target.to_get_min_fast_tracepoint_insn_len) ()
1794
35b1e5cc
SS
1795#define target_set_disconnected_tracing(val) \
1796 (*current_target.to_set_disconnected_tracing) (val)
1797
4daf5ac0
SS
1798#define target_set_circular_trace_buffer(val) \
1799 (*current_target.to_set_circular_trace_buffer) (val)
1800
f6f899bf
HAQ
1801#define target_set_trace_buffer_size(val) \
1802 (*current_target.to_set_trace_buffer_size) (val)
1803
f196051f
SS
1804#define target_set_trace_notes(user,notes,stopnotes) \
1805 (*current_target.to_set_trace_notes) ((user), (notes), (stopnotes))
1806
711e434b
PM
1807#define target_get_tib_address(ptid, addr) \
1808 (*current_target.to_get_tib_address) ((ptid), (addr))
1809
d914c394
SS
1810#define target_set_permissions() \
1811 (*current_target.to_set_permissions) ()
1812
0fb4aa4b
PA
1813#define target_static_tracepoint_marker_at(addr, marker) \
1814 (*current_target.to_static_tracepoint_marker_at) (addr, marker)
1815
1816#define target_static_tracepoint_markers_by_strid(marker_id) \
1817 (*current_target.to_static_tracepoint_markers_by_strid) (marker_id)
1818
b3b9301e
PA
1819#define target_traceframe_info() \
1820 (*current_target.to_traceframe_info) ()
1821
d1feda86
YQ
1822#define target_use_agent(use) \
1823 (*current_target.to_use_agent) (use)
1824
1825#define target_can_use_agent() \
1826 (*current_target.to_can_use_agent) ()
1827
ced63ec0
GB
1828#define target_augmented_libraries_svr4_read() \
1829 (*current_target.to_augmented_libraries_svr4_read) ()
1830
49d03eab
MR
1831/* Command logging facility. */
1832
1833#define target_log_command(p) \
1834 do \
1835 if (current_target.to_log_command) \
1836 (*current_target.to_log_command) (p); \
1837 while (0)
1838
dc146f7c
VP
1839
1840extern int target_core_of_thread (ptid_t ptid);
1841
ea001bdc
MM
1842/* See to_get_unwinder in struct target_ops. */
1843extern const struct frame_unwind *target_get_unwinder (void);
1844
1845/* See to_get_tailcall_unwinder in struct target_ops. */
1846extern const struct frame_unwind *target_get_tailcall_unwinder (void);
1847
4a5e7a5b
PA
1848/* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
1849 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
1850 if there's a mismatch, and -1 if an error is encountered while
1851 reading memory. Throws an error if the functionality is found not
1852 to be supported by the current target. */
1853int target_verify_memory (const gdb_byte *data,
1854 CORE_ADDR memaddr, ULONGEST size);
1855
c906108c
SS
1856/* Routines for maintenance of the target structures...
1857
c22a2b88
TT
1858 complete_target_initialization: Finalize a target_ops by filling in
1859 any fields needed by the target implementation.
1860
c906108c
SS
1861 add_target: Add a target to the list of all possible targets.
1862
1863 push_target: Make this target the top of the stack of currently used
c5aa993b
JM
1864 targets, within its particular stratum of the stack. Result
1865 is 0 if now atop the stack, nonzero if not on top (maybe
1866 should warn user).
c906108c
SS
1867
1868 unpush_target: Remove this from the stack of currently used targets,
c5aa993b 1869 no matter where it is on the list. Returns 0 if no
7fdc1521 1870 change, 1 if removed from stack. */
c906108c 1871
a14ed312 1872extern void add_target (struct target_ops *);
c906108c 1873
9852c492
YQ
1874extern void add_target_with_completer (struct target_ops *t,
1875 completer_ftype *completer);
1876
c22a2b88
TT
1877extern void complete_target_initialization (struct target_ops *t);
1878
b48d48eb
MM
1879/* Adds a command ALIAS for target T and marks it deprecated. This is useful
1880 for maintaining backwards compatibility when renaming targets. */
1881
1882extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
1883
b26a4dcb 1884extern void push_target (struct target_ops *);
c906108c 1885
a14ed312 1886extern int unpush_target (struct target_ops *);
c906108c 1887
fd79ecee
DJ
1888extern void target_pre_inferior (int);
1889
a14ed312 1890extern void target_preopen (int);
c906108c 1891
460014f5
JK
1892/* Does whatever cleanup is required to get rid of all pushed targets. */
1893extern void pop_all_targets (void);
aa76d38d 1894
87ab71f0
PA
1895/* Like pop_all_targets, but pops only targets whose stratum is
1896 strictly above ABOVE_STRATUM. */
460014f5 1897extern void pop_all_targets_above (enum strata above_stratum);
87ab71f0 1898
c0edd9ed
JK
1899extern int target_is_pushed (struct target_ops *t);
1900
9e35dae4
DJ
1901extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1902 CORE_ADDR offset);
1903
0542c86d 1904/* Struct target_section maps address ranges to file sections. It is
c906108c
SS
1905 mostly used with BFD files, but can be used without (e.g. for handling
1906 raw disks, or files not in formats handled by BFD). */
1907
0542c86d 1908struct target_section
c5aa993b
JM
1909 {
1910 CORE_ADDR addr; /* Lowest address in section */
1911 CORE_ADDR endaddr; /* 1+highest address in section */
c906108c 1912
7be0c536 1913 struct bfd_section *the_bfd_section;
c906108c 1914
046ac79f
JK
1915 /* The "owner" of the section.
1916 It can be any unique value. It is set by add_target_sections
1917 and used by remove_target_sections.
1918 For example, for executables it is a pointer to exec_bfd and
1919 for shlibs it is the so_list pointer. */
1920 void *owner;
c5aa993b 1921 };
c906108c 1922
07b82ea5
PA
1923/* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
1924
1925struct target_section_table
1926{
1927 struct target_section *sections;
1928 struct target_section *sections_end;
1929};
1930
8db32d44 1931/* Return the "section" containing the specified address. */
0542c86d
PA
1932struct target_section *target_section_by_addr (struct target_ops *target,
1933 CORE_ADDR addr);
8db32d44 1934
07b82ea5
PA
1935/* Return the target section table this target (or the targets
1936 beneath) currently manipulate. */
1937
1938extern struct target_section_table *target_get_section_table
1939 (struct target_ops *target);
1940
c906108c
SS
1941/* From mem-break.c */
1942
3db08215 1943extern int memory_remove_breakpoint (struct target_ops *, struct gdbarch *,
3e43a32a 1944 struct bp_target_info *);
c906108c 1945
3db08215 1946extern int memory_insert_breakpoint (struct target_ops *, struct gdbarch *,
3e43a32a 1947 struct bp_target_info *);
c906108c 1948
3e43a32a
MS
1949extern int default_memory_remove_breakpoint (struct gdbarch *,
1950 struct bp_target_info *);
917317f4 1951
3e43a32a
MS
1952extern int default_memory_insert_breakpoint (struct gdbarch *,
1953 struct bp_target_info *);
917317f4 1954
c906108c
SS
1955
1956/* From target.c */
1957
a14ed312 1958extern void initialize_targets (void);
c906108c 1959
c25c4a8b 1960extern void noprocess (void) ATTRIBUTE_NORETURN;
c906108c 1961
8edfe269
DJ
1962extern void target_require_runnable (void);
1963
136d6dae 1964extern void find_default_attach (struct target_ops *, char *, int);
c906108c 1965
136d6dae
VP
1966extern void find_default_create_inferior (struct target_ops *,
1967 char *, char *, char **, int);
c906108c 1968
a14ed312 1969extern struct target_ops *find_target_beneath (struct target_ops *);
ed9a39eb 1970
8b06beed
TT
1971/* Find the target at STRATUM. If no target is at that stratum,
1972 return NULL. */
1973
1974struct target_ops *find_target_at (enum strata stratum);
1975
e0665bc8
PA
1976/* Read OS data object of type TYPE from the target, and return it in
1977 XML format. The result is NUL-terminated and returned as a string,
1978 allocated using xmalloc. If an error occurs or the transfer is
1979 unsupported, NULL is returned. Empty objects are returned as
1980 allocated but empty strings. */
1981
07e059b5
VP
1982extern char *target_get_osdata (const char *type);
1983
c906108c
SS
1984\f
1985/* Stuff that should be shared among the various remote targets. */
1986
1987/* Debugging level. 0 is off, and non-zero values mean to print some debug
1988 information (higher values, more information). */
1989extern int remote_debug;
1990
1991/* Speed in bits per second, or -1 which means don't mess with the speed. */
1992extern int baud_rate;
c378eb4e 1993/* Timeout limit for response from target. */
c906108c
SS
1994extern int remote_timeout;
1995
c906108c 1996\f
c906108c 1997
8defab1a
DJ
1998/* Set the show memory breakpoints mode to show, and installs a cleanup
1999 to restore it back to the current value. */
2000extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
2001
d914c394
SS
2002extern int may_write_registers;
2003extern int may_write_memory;
2004extern int may_insert_breakpoints;
2005extern int may_insert_tracepoints;
2006extern int may_insert_fast_tracepoints;
2007extern int may_stop;
2008
2009extern void update_target_permissions (void);
2010
c906108c 2011\f
c378eb4e 2012/* Imported from machine dependent code. */
c906108c 2013
c378eb4e 2014/* Blank target vector entries are initialized to target_ignore. */
a14ed312 2015void target_ignore (void);
c906108c 2016
02d27625
MM
2017/* See to_supports_btrace in struct target_ops. */
2018extern int target_supports_btrace (void);
2019
2020/* See to_enable_btrace in struct target_ops. */
2021extern struct btrace_target_info *target_enable_btrace (ptid_t ptid);
2022
2023/* See to_disable_btrace in struct target_ops. */
2024extern void target_disable_btrace (struct btrace_target_info *btinfo);
2025
2026/* See to_teardown_btrace in struct target_ops. */
2027extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2028
2029/* See to_read_btrace in struct target_ops. */
969c39fb
MM
2030extern enum btrace_error target_read_btrace (VEC (btrace_block_s) **,
2031 struct btrace_target_info *,
2032 enum btrace_read_type);
02d27625 2033
7c1687a9
MM
2034/* See to_stop_recording in struct target_ops. */
2035extern void target_stop_recording (void);
2036
d02ed0bb
MM
2037/* See to_info_record in struct target_ops. */
2038extern void target_info_record (void);
2039
2040/* See to_save_record in struct target_ops. */
85e1311a 2041extern void target_save_record (const char *filename);
d02ed0bb
MM
2042
2043/* Query if the target supports deleting the execution log. */
2044extern int target_supports_delete_record (void);
2045
2046/* See to_delete_record in struct target_ops. */
2047extern void target_delete_record (void);
2048
2049/* See to_record_is_replaying in struct target_ops. */
2050extern int target_record_is_replaying (void);
2051
2052/* See to_goto_record_begin in struct target_ops. */
2053extern void target_goto_record_begin (void);
2054
2055/* See to_goto_record_end in struct target_ops. */
2056extern void target_goto_record_end (void);
2057
2058/* See to_goto_record in struct target_ops. */
2059extern void target_goto_record (ULONGEST insn);
02d27625 2060
67c86d06
MM
2061/* See to_insn_history. */
2062extern void target_insn_history (int size, int flags);
2063
2064/* See to_insn_history_from. */
2065extern void target_insn_history_from (ULONGEST from, int size, int flags);
2066
2067/* See to_insn_history_range. */
2068extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2069
15984c13
MM
2070/* See to_call_history. */
2071extern void target_call_history (int size, int flags);
2072
2073/* See to_call_history_from. */
2074extern void target_call_history_from (ULONGEST begin, int size, int flags);
2075
2076/* See to_call_history_range. */
2077extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2078
118e6252
MM
2079/* See to_decr_pc_after_break. Start searching for the target at OPS. */
2080extern CORE_ADDR forward_target_decr_pc_after_break (struct target_ops *ops,
2081 struct gdbarch *gdbarch);
2082
2083/* See to_decr_pc_after_break. */
2084extern CORE_ADDR target_decr_pc_after_break (struct gdbarch *gdbarch);
2085
c5aa993b 2086#endif /* !defined (TARGET_H) */
This page took 2.039014 seconds and 4 git commands to generate.