1 /* Generic remote debugging interface for simulators.
3 Copyright (C) 1993-2017 Free Software Foundation, Inc.
5 Contributed by Cygnus Support.
6 Steve Chamberlain (sac@cygnus.com).
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
35 #include "gdb/callback.h"
36 #include "gdb/remote-sim.h"
39 #include "sim-regno.h"
40 #include "arch-utils.h"
41 #include "readline/readline.h"
42 #include "gdbthread.h"
43 #include "common/byte-vector.h"
47 extern void _initialize_remote_sim (void);
49 static void init_callbacks (void);
51 static void end_callbacks (void);
53 static int gdb_os_write_stdout (host_callback
*, const char *, int);
55 static void gdb_os_flush_stdout (host_callback
*);
57 static int gdb_os_write_stderr (host_callback
*, const char *, int);
59 static void gdb_os_flush_stderr (host_callback
*);
61 static int gdb_os_poll_quit (host_callback
*);
63 /* printf_filtered is depreciated. */
64 static void gdb_os_printf_filtered (host_callback
*, const char *, ...);
66 static void gdb_os_vprintf_filtered (host_callback
*, const char *, va_list);
68 static void gdb_os_evprintf_filtered (host_callback
*, const char *, va_list);
70 static void gdb_os_error (host_callback
*, const char *, ...)
73 static void gdbsim_kill (struct target_ops
*);
75 static void gdbsim_load (struct target_ops
*self
, const char *prog
,
78 static void gdbsim_open (const char *args
, int from_tty
);
80 static void gdbsim_close (struct target_ops
*self
);
82 static void gdbsim_detach (struct target_ops
*ops
, const char *args
,
85 static void gdbsim_prepare_to_store (struct target_ops
*self
,
86 struct regcache
*regcache
);
88 static void gdbsim_files_info (struct target_ops
*target
);
90 static void gdbsim_mourn_inferior (struct target_ops
*target
);
92 static void gdbsim_interrupt (struct target_ops
*self
, ptid_t ptid
);
94 void simulator_command (char *args
, int from_tty
);
98 sim_* are the interface to the simulator (see remote-sim.h).
99 gdbsim_* are stuff which is internal to gdb. */
101 /* Forward data declarations */
102 extern struct target_ops gdbsim_ops
;
104 static const struct inferior_data
*sim_inferior_data_key
;
106 /* Simulator-specific, per-inferior state. */
107 struct sim_inferior_data
{
108 /* Flag which indicates whether or not the program has been loaded. */
111 /* Simulator descriptor for this inferior. */
112 SIM_DESC gdbsim_desc
;
114 /* This is the ptid we use for this particular simulator instance. Its
115 value is somewhat arbitrary, as the simulator target don't have a
116 notion of tasks or threads, but we need something non-null to place
117 in inferior_ptid. For simulators which permit multiple instances,
118 we also need a unique identifier to use for each inferior. */
119 ptid_t remote_sim_ptid
;
121 /* Signal with which to resume. */
122 enum gdb_signal resume_siggnal
;
124 /* Flag which indicates whether resume should step or not. */
128 /* Flag indicating the "open" status of this module. It's set to 1
129 in gdbsim_open() and 0 in gdbsim_close(). */
130 static int gdbsim_is_open
= 0;
132 /* Value of the next pid to allocate for an inferior. As indicated
133 elsewhere, its initial value is somewhat arbitrary; it's critical
134 though that it's not zero or negative. */
136 #define INITIAL_PID 42000
138 /* Argument list to pass to sim_open(). It is allocated in gdbsim_open()
139 and deallocated in gdbsim_close(). The lifetime needs to extend beyond
140 the call to gdbsim_open() due to the fact that other sim instances other
141 than the first will be allocated after the gdbsim_open() call. */
142 static char **sim_argv
= NULL
;
144 /* OS-level callback functions for write, flush, etc. */
145 static host_callback gdb_callback
;
146 static int callbacks_initialized
= 0;
148 /* Callback for iterate_over_inferiors. It checks to see if the sim
149 descriptor passed via ARG is the same as that for the inferior
150 designated by INF. Return true if so; false otherwise. */
153 check_for_duplicate_sim_descriptor (struct inferior
*inf
, void *arg
)
155 struct sim_inferior_data
*sim_data
;
156 SIM_DESC new_sim_desc
= (SIM_DESC
) arg
;
158 sim_data
= ((struct sim_inferior_data
*)
159 inferior_data (inf
, sim_inferior_data_key
));
161 return (sim_data
!= NULL
&& sim_data
->gdbsim_desc
== new_sim_desc
);
164 /* Flags indicating whether or not a sim instance is needed. One of these
165 flags should be passed to get_sim_inferior_data(). */
167 enum {SIM_INSTANCE_NOT_NEEDED
= 0, SIM_INSTANCE_NEEDED
= 1};
169 /* Obtain pointer to per-inferior simulator data, allocating it if necessary.
170 Attempt to open the sim if SIM_INSTANCE_NEEDED is true. */
172 static struct sim_inferior_data
*
173 get_sim_inferior_data (struct inferior
*inf
, int sim_instance_needed
)
175 SIM_DESC sim_desc
= NULL
;
176 struct sim_inferior_data
*sim_data
177 = (struct sim_inferior_data
*) inferior_data (inf
, sim_inferior_data_key
);
179 /* Try to allocate a new sim instance, if needed. We do this ahead of
180 a potential allocation of a sim_inferior_data struct in order to
181 avoid needlessly allocating that struct in the event that the sim
182 instance allocation fails. */
183 if (sim_instance_needed
== SIM_INSTANCE_NEEDED
184 && (sim_data
== NULL
|| sim_data
->gdbsim_desc
== NULL
))
186 struct inferior
*idup
;
187 sim_desc
= sim_open (SIM_OPEN_DEBUG
, &gdb_callback
, exec_bfd
, sim_argv
);
188 if (sim_desc
== NULL
)
189 error (_("Unable to create simulator instance for inferior %d."),
192 idup
= iterate_over_inferiors (check_for_duplicate_sim_descriptor
,
196 /* We don't close the descriptor due to the fact that it's
197 shared with some other inferior. If we were to close it,
198 that might needlessly muck up the other inferior. Of
199 course, it's possible that the damage has already been
200 done... Note that it *will* ultimately be closed during
201 cleanup of the other inferior. */
204 _("Inferior %d and inferior %d would have identical simulator state.\n"
205 "(This simulator does not support the running of more than one inferior.)"),
206 inf
->num
, idup
->num
);
210 if (sim_data
== NULL
)
212 sim_data
= XCNEW(struct sim_inferior_data
);
213 set_inferior_data (inf
, sim_inferior_data_key
, sim_data
);
215 /* Allocate a ptid for this inferior. */
216 sim_data
->remote_sim_ptid
= ptid_build (next_pid
, 0, next_pid
);
219 /* Initialize the other instance variables. */
220 sim_data
->program_loaded
= 0;
221 sim_data
->gdbsim_desc
= sim_desc
;
222 sim_data
->resume_siggnal
= GDB_SIGNAL_0
;
223 sim_data
->resume_step
= 0;
227 /* This handles the case where sim_data was allocated prior to
228 needing a sim instance. */
229 sim_data
->gdbsim_desc
= sim_desc
;
236 /* Return pointer to per-inferior simulator data using PTID to find the
237 inferior in question. Return NULL when no inferior is found or
238 when ptid has a zero or negative pid component. */
240 static struct sim_inferior_data
*
241 get_sim_inferior_data_by_ptid (ptid_t ptid
, int sim_instance_needed
)
243 struct inferior
*inf
;
244 int pid
= ptid_get_pid (ptid
);
249 inf
= find_inferior_pid (pid
);
252 return get_sim_inferior_data (inf
, sim_instance_needed
);
257 /* Free the per-inferior simulator data. */
260 sim_inferior_data_cleanup (struct inferior
*inf
, void *data
)
262 struct sim_inferior_data
*sim_data
= (struct sim_inferior_data
*) data
;
264 if (sim_data
!= NULL
)
266 if (sim_data
->gdbsim_desc
)
268 sim_close (sim_data
->gdbsim_desc
, 0);
269 sim_data
->gdbsim_desc
= NULL
;
276 dump_mem (const gdb_byte
*buf
, int len
)
278 fputs_unfiltered ("\t", gdb_stdlog
);
280 if (len
== 8 || len
== 4)
284 memcpy (l
, buf
, len
);
285 fprintf_unfiltered (gdb_stdlog
, "0x%08x", l
[0]);
287 fprintf_unfiltered (gdb_stdlog
, " 0x%08x", l
[1]);
293 for (i
= 0; i
< len
; i
++)
294 fprintf_unfiltered (gdb_stdlog
, "0x%02x ", buf
[i
]);
297 fputs_unfiltered ("\n", gdb_stdlog
);
300 /* Initialize gdb_callback. */
303 init_callbacks (void)
305 if (!callbacks_initialized
)
307 gdb_callback
= default_callback
;
308 gdb_callback
.init (&gdb_callback
);
309 gdb_callback
.write_stdout
= gdb_os_write_stdout
;
310 gdb_callback
.flush_stdout
= gdb_os_flush_stdout
;
311 gdb_callback
.write_stderr
= gdb_os_write_stderr
;
312 gdb_callback
.flush_stderr
= gdb_os_flush_stderr
;
313 gdb_callback
.printf_filtered
= gdb_os_printf_filtered
;
314 gdb_callback
.vprintf_filtered
= gdb_os_vprintf_filtered
;
315 gdb_callback
.evprintf_filtered
= gdb_os_evprintf_filtered
;
316 gdb_callback
.error
= gdb_os_error
;
317 gdb_callback
.poll_quit
= gdb_os_poll_quit
;
318 gdb_callback
.magic
= HOST_CALLBACK_MAGIC
;
319 callbacks_initialized
= 1;
323 /* Release callbacks (free resources used by them). */
328 if (callbacks_initialized
)
330 gdb_callback
.shutdown (&gdb_callback
);
331 callbacks_initialized
= 0;
335 /* GDB version of os_write_stdout callback. */
338 gdb_os_write_stdout (host_callback
*p
, const char *buf
, int len
)
343 ui_file_write (gdb_stdtarg
, buf
, len
);
347 /* GDB version of os_flush_stdout callback. */
350 gdb_os_flush_stdout (host_callback
*p
)
352 gdb_flush (gdb_stdtarg
);
355 /* GDB version of os_write_stderr callback. */
358 gdb_os_write_stderr (host_callback
*p
, const char *buf
, int len
)
363 for (i
= 0; i
< len
; i
++)
367 fputs_unfiltered (b
, gdb_stdtargerr
);
372 /* GDB version of os_flush_stderr callback. */
375 gdb_os_flush_stderr (host_callback
*p
)
377 gdb_flush (gdb_stdtargerr
);
380 /* GDB version of printf_filtered callback. */
383 gdb_os_printf_filtered (host_callback
* p
, const char *format
,...)
387 va_start (args
, format
);
388 vfprintf_filtered (gdb_stdout
, format
, args
);
392 /* GDB version of error vprintf_filtered. */
395 gdb_os_vprintf_filtered (host_callback
* p
, const char *format
, va_list ap
)
397 vfprintf_filtered (gdb_stdout
, format
, ap
);
400 /* GDB version of error evprintf_filtered. */
403 gdb_os_evprintf_filtered (host_callback
* p
, const char *format
, va_list ap
)
405 vfprintf_filtered (gdb_stderr
, format
, ap
);
408 /* GDB version of error callback. */
411 gdb_os_error (host_callback
* p
, const char *format
, ...)
415 va_start (args
, format
);
416 verror (format
, args
);
421 one2one_register_sim_regno (struct gdbarch
*gdbarch
, int regnum
)
423 /* Only makes sense to supply raw registers. */
424 gdb_assert (regnum
>= 0 && regnum
< gdbarch_num_regs (gdbarch
));
429 gdbsim_fetch_register (struct target_ops
*ops
,
430 struct regcache
*regcache
, int regno
)
432 struct gdbarch
*gdbarch
= get_regcache_arch (regcache
);
433 struct inferior
*inf
= find_inferior_ptid (regcache_get_ptid (regcache
));
434 struct sim_inferior_data
*sim_data
435 = get_sim_inferior_data (inf
, SIM_INSTANCE_NEEDED
);
439 for (regno
= 0; regno
< gdbarch_num_regs (gdbarch
); regno
++)
440 gdbsim_fetch_register (ops
, regcache
, regno
);
444 switch (gdbarch_register_sim_regno (gdbarch
, regno
))
446 case LEGACY_SIM_REGNO_IGNORE
:
448 case SIM_REGNO_DOES_NOT_EXIST
:
450 /* For moment treat a `does not exist' register the same way
451 as an ``unavailable'' register. */
452 regcache
->raw_supply_zeroed (regno
);
458 static int warn_user
= 1;
459 int regsize
= register_size (gdbarch
, regno
);
460 gdb::byte_vector
buf (regsize
, 0);
463 gdb_assert (regno
>= 0 && regno
< gdbarch_num_regs (gdbarch
));
464 nr_bytes
= sim_fetch_register (sim_data
->gdbsim_desc
,
465 gdbarch_register_sim_regno
467 buf
.data (), regsize
);
468 if (nr_bytes
> 0 && nr_bytes
!= regsize
&& warn_user
)
470 fprintf_unfiltered (gdb_stderr
,
471 "Size of register %s (%d/%d) "
472 "incorrect (%d instead of %d))",
473 gdbarch_register_name (gdbarch
, regno
),
475 gdbarch_register_sim_regno (gdbarch
, regno
),
479 /* FIXME: cagney/2002-05-27: Should check `nr_bytes == 0'
480 indicating that GDB and the SIM have different ideas about
481 which registers are fetchable. */
482 /* Else if (nr_bytes < 0): an old simulator, that doesn't
483 think to return the register size. Just assume all is ok. */
484 regcache
->raw_supply (regno
, buf
.data ());
487 fprintf_unfiltered (gdb_stdlog
,
488 "gdbsim_fetch_register: %d", regno
);
489 /* FIXME: We could print something more intelligible. */
490 dump_mem (buf
.data (), regsize
);
499 gdbsim_store_register (struct target_ops
*ops
,
500 struct regcache
*regcache
, int regno
)
502 struct gdbarch
*gdbarch
= get_regcache_arch (regcache
);
503 struct inferior
*inf
= find_inferior_ptid (regcache_get_ptid (regcache
));
504 struct sim_inferior_data
*sim_data
505 = get_sim_inferior_data (inf
, SIM_INSTANCE_NEEDED
);
509 for (regno
= 0; regno
< gdbarch_num_regs (gdbarch
); regno
++)
510 gdbsim_store_register (ops
, regcache
, regno
);
513 else if (gdbarch_register_sim_regno (gdbarch
, regno
) >= 0)
515 int regsize
= register_size (gdbarch
, regno
);
516 gdb::byte_vector
tmp (regsize
);
519 regcache
->cooked_read (regno
, tmp
.data ());
520 nr_bytes
= sim_store_register (sim_data
->gdbsim_desc
,
521 gdbarch_register_sim_regno
523 tmp
.data (), regsize
);
525 if (nr_bytes
> 0 && nr_bytes
!= regsize
)
526 internal_error (__FILE__
, __LINE__
,
527 _("Register size different to expected"));
529 internal_error (__FILE__
, __LINE__
,
530 _("Register %d not updated"), regno
);
532 warning (_("Register %s not updated"),
533 gdbarch_register_name (gdbarch
, regno
));
537 fprintf_unfiltered (gdb_stdlog
, "gdbsim_store_register: %d", regno
);
538 /* FIXME: We could print something more intelligible. */
539 dump_mem (tmp
.data (), regsize
);
544 /* Kill the running program. This may involve closing any open files
545 and releasing other resources acquired by the simulated program. */
548 gdbsim_kill (struct target_ops
*ops
)
551 fprintf_unfiltered (gdb_stdlog
, "gdbsim_kill\n");
553 /* There is no need to `kill' running simulator - the simulator is
554 not running. Mourning it is enough. */
555 target_mourn_inferior (inferior_ptid
);
558 /* Load an executable file into the target process. This is expected to
559 not only bring new code into the target process, but also to update
560 GDB's symbol tables to match. */
563 gdbsim_load (struct target_ops
*self
, const char *args
, int fromtty
)
566 struct sim_inferior_data
*sim_data
567 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED
);
570 error_no_arg (_("program to load"));
572 gdb_argv
argv (args
);
574 prog
= tilde_expand (argv
[0]);
577 error (_("GDB sim does not yet support a load offset."));
580 fprintf_unfiltered (gdb_stdlog
, "gdbsim_load: prog \"%s\"\n", prog
);
582 /* FIXME: We will print two messages on error.
583 Need error to either not print anything if passed NULL or need
584 another routine that doesn't take any arguments. */
585 if (sim_load (sim_data
->gdbsim_desc
, prog
, NULL
, fromtty
) == SIM_RC_FAIL
)
586 error (_("unable to load program"));
588 /* FIXME: If a load command should reset the targets registers then
589 a call to sim_create_inferior() should go here. */
591 sim_data
->program_loaded
= 1;
595 /* Start an inferior process and set inferior_ptid to its pid.
596 EXEC_FILE is the file to run.
597 ARGS is a string containing the arguments to the program.
598 ENV is the environment vector to pass. Errors reported with error().
599 On VxWorks and various standalone systems, we ignore exec_file. */
600 /* This is called not only when we first attach, but also when the
601 user types "run" after having attached. */
604 gdbsim_create_inferior (struct target_ops
*target
, const char *exec_file
,
605 const std::string
&allargs
, char **env
, int from_tty
)
607 struct sim_inferior_data
*sim_data
608 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED
);
611 const char *args
= allargs
.c_str ();
613 if (exec_file
== 0 || exec_bfd
== 0)
614 warning (_("No executable file specified."));
615 if (!sim_data
->program_loaded
)
616 warning (_("No program loaded."));
619 fprintf_unfiltered (gdb_stdlog
,
620 "gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
621 (exec_file
? exec_file
: "(NULL)"),
624 if (ptid_equal (inferior_ptid
, sim_data
->remote_sim_ptid
))
625 gdbsim_kill (target
);
626 remove_breakpoints ();
627 init_wait_for_inferior ();
630 if (exec_file
!= NULL
)
632 len
= strlen (exec_file
) + 1 + allargs
.size () + 1 + /*slop */ 10;
633 arg_buf
= (char *) alloca (len
);
635 strcat (arg_buf
, exec_file
);
636 strcat (arg_buf
, " ");
637 strcat (arg_buf
, args
);
638 built_argv
.reset (arg_buf
);
641 if (!have_inferiors ())
644 if (sim_create_inferior (sim_data
->gdbsim_desc
, exec_bfd
,
645 built_argv
.get (), env
)
647 error (_("Unable to create sim inferior."));
649 inferior_ptid
= sim_data
->remote_sim_ptid
;
650 inferior_appeared (current_inferior (), ptid_get_pid (inferior_ptid
));
651 add_thread_silent (inferior_ptid
);
653 insert_breakpoints (); /* Needed to get correct instruction
656 clear_proceed_status (0);
659 /* The open routine takes the rest of the parameters from the command,
660 and (if successful) pushes a new target onto the stack.
661 Targets should supply this routine, if only to provide an error message. */
662 /* Called when selecting the simulator. E.g. (gdb) target sim name. */
665 gdbsim_open (const char *args
, int from_tty
)
669 struct sim_inferior_data
*sim_data
;
671 SIM_DESC gdbsim_desc
;
673 sysroot
= gdb_sysroot
;
674 if (is_target_filename (sysroot
))
675 sysroot
+= strlen (TARGET_SYSROOT_PREFIX
);
678 fprintf_unfiltered (gdb_stdlog
,
679 "gdbsim_open: args \"%s\"\n", args
? args
: "(null)");
681 /* Ensure that the sim target is not on the target stack. This is
682 necessary, because if it is on the target stack, the call to
683 push_target below will invoke sim_close(), thus freeing various
684 state (including a sim instance) that we allocate prior to
685 invoking push_target(). We want to delay the push_target()
686 operation until after we complete those operations which could
689 unpush_target (&gdbsim_ops
);
691 len
= (7 + 1 /* gdbsim */
692 + strlen (" -E little")
693 + strlen (" --architecture=xxxxxxxxxx")
694 + strlen (" --sysroot=") + strlen (sysroot
) +
695 + (args
? strlen (args
) : 0)
697 arg_buf
= (char *) alloca (len
);
698 strcpy (arg_buf
, "gdbsim"); /* 7 */
699 /* Specify the byte order for the target when it is explicitly
700 specified by the user (not auto detected). */
701 switch (selected_byte_order ())
704 strcat (arg_buf
, " -E big");
706 case BFD_ENDIAN_LITTLE
:
707 strcat (arg_buf
, " -E little");
709 case BFD_ENDIAN_UNKNOWN
:
712 /* Specify the architecture of the target when it has been
713 explicitly specified */
714 if (selected_architecture_name () != NULL
)
716 strcat (arg_buf
, " --architecture=");
717 strcat (arg_buf
, selected_architecture_name ());
719 /* Pass along gdb's concept of the sysroot. */
720 strcat (arg_buf
, " --sysroot=");
721 strcat (arg_buf
, sysroot
);
722 /* finally, any explicit args */
725 strcat (arg_buf
, " "); /* 1 */
726 strcat (arg_buf
, args
);
729 gdb_argv
argv (arg_buf
);
730 sim_argv
= argv
.get ();
733 gdbsim_desc
= sim_open (SIM_OPEN_DEBUG
, &gdb_callback
, exec_bfd
, sim_argv
);
735 if (gdbsim_desc
== 0)
738 error (_("unable to create simulator instance"));
743 /* Reset the pid numberings for this batch of sim instances. */
744 next_pid
= INITIAL_PID
;
746 /* Allocate the inferior data, but do not allocate a sim instance
747 since we've already just done that. */
748 sim_data
= get_sim_inferior_data (current_inferior (),
749 SIM_INSTANCE_NOT_NEEDED
);
751 sim_data
->gdbsim_desc
= gdbsim_desc
;
753 push_target (&gdbsim_ops
);
754 printf_filtered ("Connected to the simulator.\n");
756 /* There's nothing running after "target sim" or "load"; not until
758 inferior_ptid
= null_ptid
;
763 /* Callback for iterate_over_inferiors. Called (indirectly) by
767 gdbsim_close_inferior (struct inferior
*inf
, void *arg
)
769 struct sim_inferior_data
*sim_data
770 = (struct sim_inferior_data
*) inferior_data (inf
, sim_inferior_data_key
);
771 if (sim_data
!= NULL
)
773 ptid_t ptid
= sim_data
->remote_sim_ptid
;
775 sim_inferior_data_cleanup (inf
, sim_data
);
776 set_inferior_data (inf
, sim_inferior_data_key
, NULL
);
778 /* Having a ptid allocated and stored in remote_sim_ptid does
779 not mean that a corresponding inferior was ever created.
780 Thus we need to verify the existence of an inferior using the
781 pid in question before setting inferior_ptid via
782 switch_to_thread() or mourning the inferior. */
783 if (find_inferior_ptid (ptid
) != NULL
)
785 switch_to_thread (ptid
);
786 generic_mourn_inferior ();
793 /* Close out all files and local state before this target loses control. */
796 gdbsim_close (struct target_ops
*self
)
798 struct sim_inferior_data
*sim_data
799 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
802 fprintf_unfiltered (gdb_stdlog
, "gdbsim_close\n");
804 iterate_over_inferiors (gdbsim_close_inferior
, NULL
);
806 if (sim_argv
!= NULL
)
817 /* Takes a program previously attached to and detaches it.
818 The program may resume execution (some targets do, some don't) and will
819 no longer stop on signals, etc. We better not have left any breakpoints
820 in the program or it'll die when it hits one. ARGS is arguments
821 typed by the user (e.g. a signal to send the process). FROM_TTY
822 says whether to be verbose or not. */
823 /* Terminate the open connection to the remote debugger.
824 Use this when you want to detach and do something else with your gdb. */
827 gdbsim_detach (struct target_ops
*ops
, const char *args
, int from_tty
)
830 fprintf_unfiltered (gdb_stdlog
, "gdbsim_detach: args \"%s\"\n", args
);
832 unpush_target (ops
); /* calls gdbsim_close to do the real work */
834 printf_filtered ("Ending simulator %s debugging\n", target_shortname
);
837 /* Resume execution of the target process. STEP says whether to single-step
838 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
839 to the target, or zero for no signal. */
843 enum gdb_signal siggnal
;
848 gdbsim_resume_inferior (struct inferior
*inf
, void *arg
)
850 struct sim_inferior_data
*sim_data
851 = get_sim_inferior_data (inf
, SIM_INSTANCE_NOT_NEEDED
);
852 struct resume_data
*rd
= (struct resume_data
*) arg
;
856 sim_data
->resume_siggnal
= rd
->siggnal
;
857 sim_data
->resume_step
= rd
->step
;
860 fprintf_unfiltered (gdb_stdlog
,
861 _("gdbsim_resume: pid %d, step %d, signal %d\n"),
862 inf
->pid
, rd
->step
, rd
->siggnal
);
865 /* When called from iterate_over_inferiors, a zero return causes the
866 iteration process to proceed until there are no more inferiors to
872 gdbsim_resume (struct target_ops
*ops
,
873 ptid_t ptid
, int step
, enum gdb_signal siggnal
)
875 struct resume_data rd
;
876 struct sim_inferior_data
*sim_data
877 = get_sim_inferior_data_by_ptid (ptid
, SIM_INSTANCE_NOT_NEEDED
);
879 rd
.siggnal
= siggnal
;
882 /* We don't access any sim_data members within this function.
883 What's of interest is whether or not the call to
884 get_sim_inferior_data_by_ptid(), above, is able to obtain a
885 non-NULL pointer. If it managed to obtain a non-NULL pointer, we
886 know we have a single inferior to consider. If it's NULL, we
887 either have multiple inferiors to resume or an error condition. */
890 gdbsim_resume_inferior (find_inferior_ptid (ptid
), &rd
);
891 else if (ptid_equal (ptid
, minus_one_ptid
))
892 iterate_over_inferiors (gdbsim_resume_inferior
, &rd
);
894 error (_("The program is not being run."));
897 /* Notify the simulator of an asynchronous request to interrupt.
899 The simulator shall ensure that the interrupt request is eventually
900 delivered to the simulator. If the call is made while the
901 simulator is not running then the interrupt request is processed when
902 the simulator is next resumed.
904 For simulators that do not support this operation, just abort. */
907 gdbsim_interrupt_inferior (struct inferior
*inf
, void *arg
)
909 struct sim_inferior_data
*sim_data
910 = get_sim_inferior_data (inf
, SIM_INSTANCE_NEEDED
);
914 if (!sim_stop (sim_data
->gdbsim_desc
))
920 /* When called from iterate_over_inferiors, a zero return causes the
921 iteration process to proceed until there are no more inferiors to
927 gdbsim_interrupt (struct target_ops
*self
, ptid_t ptid
)
929 struct sim_inferior_data
*sim_data
;
931 if (ptid_equal (ptid
, minus_one_ptid
))
933 iterate_over_inferiors (gdbsim_interrupt_inferior
, NULL
);
937 struct inferior
*inf
= find_inferior_ptid (ptid
);
940 error (_("Can't stop pid %d. No inferior found."),
941 ptid_get_pid (ptid
));
943 gdbsim_interrupt_inferior (inf
, NULL
);
947 /* GDB version of os_poll_quit callback.
948 Taken from gdb/util.c - should be in a library. */
951 gdb_os_poll_quit (host_callback
*p
)
953 if (deprecated_ui_loop_hook
!= NULL
)
954 deprecated_ui_loop_hook (0);
956 if (check_quit_flag ()) /* gdb's idea of quit */
961 /* Wait for inferior process to do something. Return pid of child,
962 or -1 in case of error; store status through argument pointer STATUS,
963 just as `wait' would. */
966 gdbsim_cntrl_c (int signo
)
968 gdbsim_interrupt (NULL
, minus_one_ptid
);
972 gdbsim_wait (struct target_ops
*ops
,
973 ptid_t ptid
, struct target_waitstatus
*status
, int options
)
975 struct sim_inferior_data
*sim_data
;
976 static sighandler_t prev_sigint
;
978 enum sim_stop reason
= sim_running
;
980 /* This target isn't able to (yet) resume more than one inferior at a time.
981 When ptid is minus_one_ptid, just use the current inferior. If we're
982 given an explicit pid, we'll try to find it and use that instead. */
983 if (ptid_equal (ptid
, minus_one_ptid
))
984 sim_data
= get_sim_inferior_data (current_inferior (),
985 SIM_INSTANCE_NEEDED
);
988 sim_data
= get_sim_inferior_data_by_ptid (ptid
, SIM_INSTANCE_NEEDED
);
989 if (sim_data
== NULL
)
990 error (_("Unable to wait for pid %d. Inferior not found."),
991 ptid_get_pid (ptid
));
992 inferior_ptid
= ptid
;
996 fprintf_unfiltered (gdb_stdlog
, "gdbsim_wait\n");
998 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1000 struct sigaction sa
, osa
;
1001 sa
.sa_handler
= gdbsim_cntrl_c
;
1002 sigemptyset (&sa
.sa_mask
);
1004 sigaction (SIGINT
, &sa
, &osa
);
1005 prev_sigint
= osa
.sa_handler
;
1008 prev_sigint
= signal (SIGINT
, gdbsim_cntrl_c
);
1010 sim_resume (sim_data
->gdbsim_desc
, sim_data
->resume_step
,
1011 sim_data
->resume_siggnal
);
1013 signal (SIGINT
, prev_sigint
);
1014 sim_data
->resume_step
= 0;
1016 sim_stop_reason (sim_data
->gdbsim_desc
, &reason
, &sigrc
);
1021 status
->kind
= TARGET_WAITKIND_EXITED
;
1022 status
->value
.integer
= sigrc
;
1027 case GDB_SIGNAL_ABRT
:
1030 case GDB_SIGNAL_INT
:
1031 case GDB_SIGNAL_TRAP
:
1033 status
->kind
= TARGET_WAITKIND_STOPPED
;
1034 status
->value
.sig
= (enum gdb_signal
) sigrc
;
1039 status
->kind
= TARGET_WAITKIND_SIGNALLED
;
1040 status
->value
.sig
= (enum gdb_signal
) sigrc
;
1044 /* FIXME: Is this correct? */
1048 return inferior_ptid
;
1051 /* Get ready to modify the registers array. On machines which store
1052 individual registers, this doesn't need to do anything. On machines
1053 which store all the registers in one fell swoop, this makes sure
1054 that registers contains all the registers from the program being
1058 gdbsim_prepare_to_store (struct target_ops
*self
, struct regcache
*regcache
)
1060 /* Do nothing, since we can store individual regs. */
1063 /* Helper for gdbsim_xfer_partial that handles memory transfers.
1064 Arguments are like target_xfer_partial. */
1066 static enum target_xfer_status
1067 gdbsim_xfer_memory (struct target_ops
*target
,
1068 gdb_byte
*readbuf
, const gdb_byte
*writebuf
,
1069 ULONGEST memaddr
, ULONGEST len
, ULONGEST
*xfered_len
)
1071 struct sim_inferior_data
*sim_data
1072 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
1075 /* If this target doesn't have memory yet, return 0 causing the
1076 request to be passed to a lower target, hopefully an exec
1078 if (!target
->to_has_memory (target
))
1079 return TARGET_XFER_EOF
;
1081 if (!sim_data
->program_loaded
)
1082 error (_("No program loaded."));
1084 /* Note that we obtained the sim_data pointer above using
1085 SIM_INSTANCE_NOT_NEEDED. We do this so that we don't needlessly
1086 allocate a sim instance prior to loading a program. If we
1087 get to this point in the code though, gdbsim_desc should be
1088 non-NULL. (Note that a sim instance is needed in order to load
1090 gdb_assert (sim_data
->gdbsim_desc
!= NULL
);
1093 fprintf_unfiltered (gdb_stdlog
,
1094 "gdbsim_xfer_memory: readbuf %s, writebuf %s, "
1095 "memaddr %s, len %s\n",
1096 host_address_to_string (readbuf
),
1097 host_address_to_string (writebuf
),
1098 paddress (target_gdbarch (), memaddr
),
1103 if (remote_debug
&& len
> 0)
1104 dump_mem (writebuf
, len
);
1105 l
= sim_write (sim_data
->gdbsim_desc
, memaddr
, writebuf
, len
);
1109 l
= sim_read (sim_data
->gdbsim_desc
, memaddr
, readbuf
, len
);
1110 if (remote_debug
&& len
> 0)
1111 dump_mem (readbuf
, len
);
1115 *xfered_len
= (ULONGEST
) l
;
1116 return TARGET_XFER_OK
;
1119 return TARGET_XFER_EOF
;
1121 return TARGET_XFER_E_IO
;
1124 /* Target to_xfer_partial implementation. */
1126 static enum target_xfer_status
1127 gdbsim_xfer_partial (struct target_ops
*ops
, enum target_object object
,
1128 const char *annex
, gdb_byte
*readbuf
,
1129 const gdb_byte
*writebuf
, ULONGEST offset
, ULONGEST len
,
1130 ULONGEST
*xfered_len
)
1134 case TARGET_OBJECT_MEMORY
:
1135 return gdbsim_xfer_memory (ops
, readbuf
, writebuf
, offset
, len
,
1139 return TARGET_XFER_E_IO
;
1144 gdbsim_files_info (struct target_ops
*target
)
1146 struct sim_inferior_data
*sim_data
1147 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED
);
1148 const char *file
= "nothing";
1151 file
= bfd_get_filename (exec_bfd
);
1154 fprintf_unfiltered (gdb_stdlog
, "gdbsim_files_info: file \"%s\"\n", file
);
1158 fprintf_unfiltered (gdb_stdlog
, "\tAttached to %s running program %s\n",
1159 target_shortname
, file
);
1160 sim_info (sim_data
->gdbsim_desc
, 0);
1164 /* Clear the simulator's notion of what the break points are. */
1167 gdbsim_mourn_inferior (struct target_ops
*target
)
1169 struct sim_inferior_data
*sim_data
1170 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
1173 fprintf_unfiltered (gdb_stdlog
, "gdbsim_mourn_inferior:\n");
1175 remove_breakpoints ();
1176 generic_mourn_inferior ();
1177 delete_thread_silent (sim_data
->remote_sim_ptid
);
1180 /* Pass the command argument through to the simulator verbatim. The
1181 simulator must do any command interpretation work. */
1184 simulator_command (char *args
, int from_tty
)
1186 struct sim_inferior_data
*sim_data
;
1188 /* We use inferior_data() instead of get_sim_inferior_data() here in
1189 order to avoid attaching a sim_inferior_data struct to an
1190 inferior unnecessarily. The reason we take such care here is due
1191 to the fact that this function, simulator_command(), may be called
1192 even when the sim target is not active. If we were to use
1193 get_sim_inferior_data() here, it is possible that this call would
1194 be made either prior to gdbsim_open() or after gdbsim_close(),
1195 thus allocating memory that would not be garbage collected until
1196 the ultimate destruction of the associated inferior. */
1198 sim_data
= ((struct sim_inferior_data
*)
1199 inferior_data (current_inferior (), sim_inferior_data_key
));
1200 if (sim_data
== NULL
|| sim_data
->gdbsim_desc
== NULL
)
1203 /* PREVIOUSLY: The user may give a command before the simulator
1204 is opened. [...] (??? assuming of course one wishes to
1205 continue to allow commands to be sent to unopened simulators,
1206 which isn't entirely unreasonable). */
1208 /* The simulator is a builtin abstraction of a remote target.
1209 Consistent with that model, access to the simulator, via sim
1210 commands, is restricted to the period when the channel to the
1211 simulator is open. */
1213 error (_("Not connected to the simulator target"));
1216 sim_do_command (sim_data
->gdbsim_desc
, args
);
1218 /* Invalidate the register cache, in case the simulator command does
1220 registers_changed ();
1224 sim_command_completer (struct cmd_list_element
*ignore
,
1225 completion_tracker
&tracker
,
1226 const char *text
, const char *word
)
1228 struct sim_inferior_data
*sim_data
;
1230 sim_data
= ((struct sim_inferior_data
*)
1231 inferior_data (current_inferior (), sim_inferior_data_key
));
1232 if (sim_data
== NULL
|| sim_data
->gdbsim_desc
== NULL
)
1235 /* sim_complete_command returns a NULL-terminated malloc'ed array of
1236 malloc'ed strings. */
1237 struct sim_completions_deleter
1239 void operator() (char **ptr
) const
1241 for (size_t i
= 0; ptr
[i
] != NULL
; i
++)
1247 std::unique_ptr
<char *[], sim_completions_deleter
> sim_completions
1248 (sim_complete_command (sim_data
->gdbsim_desc
, text
, word
));
1249 if (sim_completions
== NULL
)
1252 /* Count the elements and add completions from tail to head because
1253 below we'll swap elements out of the array in case add_completion
1254 throws and the deleter deletes until it finds a NULL element. */
1256 while (sim_completions
[count
] != NULL
)
1259 for (size_t i
= count
; i
> 0; i
--)
1261 gdb::unique_xmalloc_ptr
<char> match (sim_completions
[i
- 1]);
1262 sim_completions
[i
- 1] = NULL
;
1263 tracker
.add_completion (std::move (match
));
1267 /* Check to see if a thread is still alive. */
1270 gdbsim_thread_alive (struct target_ops
*ops
, ptid_t ptid
)
1272 struct sim_inferior_data
*sim_data
1273 = get_sim_inferior_data_by_ptid (ptid
, SIM_INSTANCE_NOT_NEEDED
);
1275 if (sim_data
== NULL
)
1278 if (ptid_equal (ptid
, sim_data
->remote_sim_ptid
))
1279 /* The simulators' task is always alive. */
1285 /* Convert a thread ID to a string. Returns the string in a static
1289 gdbsim_pid_to_str (struct target_ops
*ops
, ptid_t ptid
)
1291 return normal_pid_to_str (ptid
);
1294 /* Simulator memory may be accessed after the program has been loaded. */
1297 gdbsim_has_all_memory (struct target_ops
*ops
)
1299 struct sim_inferior_data
*sim_data
1300 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
1302 if (!sim_data
->program_loaded
)
1309 gdbsim_has_memory (struct target_ops
*ops
)
1311 struct sim_inferior_data
*sim_data
1312 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
1314 if (!sim_data
->program_loaded
)
1320 /* Define the target subroutine names. */
1322 struct target_ops gdbsim_ops
;
1325 init_gdbsim_ops (void)
1327 gdbsim_ops
.to_shortname
= "sim";
1328 gdbsim_ops
.to_longname
= "simulator";
1329 gdbsim_ops
.to_doc
= "Use the compiled-in simulator.";
1330 gdbsim_ops
.to_open
= gdbsim_open
;
1331 gdbsim_ops
.to_close
= gdbsim_close
;
1332 gdbsim_ops
.to_detach
= gdbsim_detach
;
1333 gdbsim_ops
.to_resume
= gdbsim_resume
;
1334 gdbsim_ops
.to_wait
= gdbsim_wait
;
1335 gdbsim_ops
.to_fetch_registers
= gdbsim_fetch_register
;
1336 gdbsim_ops
.to_store_registers
= gdbsim_store_register
;
1337 gdbsim_ops
.to_prepare_to_store
= gdbsim_prepare_to_store
;
1338 gdbsim_ops
.to_xfer_partial
= gdbsim_xfer_partial
;
1339 gdbsim_ops
.to_files_info
= gdbsim_files_info
;
1340 gdbsim_ops
.to_insert_breakpoint
= memory_insert_breakpoint
;
1341 gdbsim_ops
.to_remove_breakpoint
= memory_remove_breakpoint
;
1342 gdbsim_ops
.to_kill
= gdbsim_kill
;
1343 gdbsim_ops
.to_load
= gdbsim_load
;
1344 gdbsim_ops
.to_create_inferior
= gdbsim_create_inferior
;
1345 gdbsim_ops
.to_mourn_inferior
= gdbsim_mourn_inferior
;
1346 gdbsim_ops
.to_interrupt
= gdbsim_interrupt
;
1347 gdbsim_ops
.to_thread_alive
= gdbsim_thread_alive
;
1348 gdbsim_ops
.to_pid_to_str
= gdbsim_pid_to_str
;
1349 gdbsim_ops
.to_stratum
= process_stratum
;
1350 gdbsim_ops
.to_has_all_memory
= gdbsim_has_all_memory
;
1351 gdbsim_ops
.to_has_memory
= gdbsim_has_memory
;
1352 gdbsim_ops
.to_has_stack
= default_child_has_stack
;
1353 gdbsim_ops
.to_has_registers
= default_child_has_registers
;
1354 gdbsim_ops
.to_has_execution
= default_child_has_execution
;
1355 gdbsim_ops
.to_magic
= OPS_MAGIC
;
1359 _initialize_remote_sim (void)
1361 struct cmd_list_element
*c
;
1364 add_target (&gdbsim_ops
);
1366 c
= add_com ("sim", class_obscure
, simulator_command
,
1367 _("Send a command to the simulator."));
1368 set_cmd_completer (c
, sim_command_completer
);
1370 sim_inferior_data_key
1371 = register_inferior_data_with_cleanup (NULL
, sim_inferior_data_cleanup
);