1 /* Generic remote debugging interface for simulators.
3 Copyright (C) 1993-2014 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 "gdb_assert.h"
40 #include "sim-regno.h"
41 #include "arch-utils.h"
42 #include "readline/readline.h"
43 #include "gdbthread.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 (char *prog
, int fromtty
);
77 static void gdbsim_open (char *args
, int from_tty
);
79 static void gdbsim_close (void);
81 static void gdbsim_detach (struct target_ops
*ops
, const char *args
,
84 static void gdbsim_prepare_to_store (struct regcache
*regcache
);
86 static void gdbsim_files_info (struct target_ops
*target
);
88 static void gdbsim_mourn_inferior (struct target_ops
*target
);
90 static void gdbsim_stop (ptid_t ptid
);
92 void simulator_command (char *args
, int from_tty
);
96 sim_* are the interface to the simulator (see remote-sim.h).
97 gdbsim_* are stuff which is internal to gdb. */
99 /* Forward data declarations */
100 extern struct target_ops gdbsim_ops
;
102 static const struct inferior_data
*sim_inferior_data_key
;
104 /* Simulator-specific, per-inferior state. */
105 struct sim_inferior_data
{
106 /* Flag which indicates whether or not the program has been loaded. */
109 /* Simulator descriptor for this inferior. */
110 SIM_DESC gdbsim_desc
;
112 /* This is the ptid we use for this particular simulator instance. Its
113 value is somewhat arbitrary, as the simulator target don't have a
114 notion of tasks or threads, but we need something non-null to place
115 in inferior_ptid. For simulators which permit multiple instances,
116 we also need a unique identifier to use for each inferior. */
117 ptid_t remote_sim_ptid
;
119 /* Signal with which to resume. */
120 enum gdb_signal resume_siggnal
;
122 /* Flag which indicates whether resume should step or not. */
126 /* Flag indicating the "open" status of this module. It's set to 1
127 in gdbsim_open() and 0 in gdbsim_close(). */
128 static int gdbsim_is_open
= 0;
130 /* Value of the next pid to allocate for an inferior. As indicated
131 elsewhere, its initial value is somewhat arbitrary; it's critical
132 though that it's not zero or negative. */
134 #define INITIAL_PID 42000
136 /* Argument list to pass to sim_open(). It is allocated in gdbsim_open()
137 and deallocated in gdbsim_close(). The lifetime needs to extend beyond
138 the call to gdbsim_open() due to the fact that other sim instances other
139 than the first will be allocated after the gdbsim_open() call. */
140 static char **sim_argv
= NULL
;
142 /* OS-level callback functions for write, flush, etc. */
143 static host_callback gdb_callback
;
144 static int callbacks_initialized
= 0;
146 /* Callback for iterate_over_inferiors. It checks to see if the sim
147 descriptor passed via ARG is the same as that for the inferior
148 designated by INF. Return true if so; false otherwise. */
151 check_for_duplicate_sim_descriptor (struct inferior
*inf
, void *arg
)
153 struct sim_inferior_data
*sim_data
;
154 SIM_DESC new_sim_desc
= arg
;
156 sim_data
= inferior_data (inf
, sim_inferior_data_key
);
158 return (sim_data
!= NULL
&& sim_data
->gdbsim_desc
== new_sim_desc
);
161 /* Flags indicating whether or not a sim instance is needed. One of these
162 flags should be passed to get_sim_inferior_data(). */
164 enum {SIM_INSTANCE_NOT_NEEDED
= 0, SIM_INSTANCE_NEEDED
= 1};
166 /* Obtain pointer to per-inferior simulator data, allocating it if necessary.
167 Attempt to open the sim if SIM_INSTANCE_NEEDED is true. */
169 static struct sim_inferior_data
*
170 get_sim_inferior_data (struct inferior
*inf
, int sim_instance_needed
)
172 SIM_DESC sim_desc
= NULL
;
173 struct sim_inferior_data
*sim_data
174 = inferior_data (inf
, sim_inferior_data_key
);
176 /* Try to allocate a new sim instance, if needed. We do this ahead of
177 a potential allocation of a sim_inferior_data struct in order to
178 avoid needlessly allocating that struct in the event that the sim
179 instance allocation fails. */
180 if (sim_instance_needed
== SIM_INSTANCE_NEEDED
181 && (sim_data
== NULL
|| sim_data
->gdbsim_desc
== NULL
))
183 struct inferior
*idup
;
184 sim_desc
= sim_open (SIM_OPEN_DEBUG
, &gdb_callback
, exec_bfd
, sim_argv
);
185 if (sim_desc
== NULL
)
186 error (_("Unable to create simulator instance for inferior %d."),
189 idup
= iterate_over_inferiors (check_for_duplicate_sim_descriptor
,
193 /* We don't close the descriptor due to the fact that it's
194 shared with some other inferior. If we were to close it,
195 that might needlessly muck up the other inferior. Of
196 course, it's possible that the damage has already been
197 done... Note that it *will* ultimately be closed during
198 cleanup of the other inferior. */
201 _("Inferior %d and inferior %d would have identical simulator state.\n"
202 "(This simulator does not support the running of more than one inferior.)"),
203 inf
->num
, idup
->num
);
207 if (sim_data
== NULL
)
209 sim_data
= XCNEW(struct sim_inferior_data
);
210 set_inferior_data (inf
, sim_inferior_data_key
, sim_data
);
212 /* Allocate a ptid for this inferior. */
213 sim_data
->remote_sim_ptid
= ptid_build (next_pid
, 0, next_pid
);
216 /* Initialize the other instance variables. */
217 sim_data
->program_loaded
= 0;
218 sim_data
->gdbsim_desc
= sim_desc
;
219 sim_data
->resume_siggnal
= GDB_SIGNAL_0
;
220 sim_data
->resume_step
= 0;
224 /* This handles the case where sim_data was allocated prior to
225 needing a sim instance. */
226 sim_data
->gdbsim_desc
= sim_desc
;
233 /* Return pointer to per-inferior simulator data using PTID to find the
234 inferior in question. Return NULL when no inferior is found or
235 when ptid has a zero or negative pid component. */
237 static struct sim_inferior_data
*
238 get_sim_inferior_data_by_ptid (ptid_t ptid
, int sim_instance_needed
)
240 struct inferior
*inf
;
241 int pid
= ptid_get_pid (ptid
);
246 inf
= find_inferior_pid (pid
);
249 return get_sim_inferior_data (inf
, sim_instance_needed
);
254 /* Free the per-inferior simulator data. */
257 sim_inferior_data_cleanup (struct inferior
*inf
, void *data
)
259 struct sim_inferior_data
*sim_data
= data
;
261 if (sim_data
!= NULL
)
263 if (sim_data
->gdbsim_desc
)
265 sim_close (sim_data
->gdbsim_desc
, 0);
266 sim_data
->gdbsim_desc
= NULL
;
273 dump_mem (const gdb_byte
*buf
, int len
)
275 fputs_unfiltered ("\t", gdb_stdlog
);
277 if (len
== 8 || len
== 4)
281 memcpy (l
, buf
, len
);
282 fprintf_unfiltered (gdb_stdlog
, "0x%08x", l
[0]);
284 fprintf_unfiltered (gdb_stdlog
, " 0x%08x", l
[1]);
290 for (i
= 0; i
< len
; i
++)
291 fprintf_unfiltered (gdb_stdlog
, "0x%02x ", buf
[i
]);
294 fputs_unfiltered ("\n", gdb_stdlog
);
297 /* Initialize gdb_callback. */
300 init_callbacks (void)
302 if (!callbacks_initialized
)
304 gdb_callback
= default_callback
;
305 gdb_callback
.init (&gdb_callback
);
306 gdb_callback
.write_stdout
= gdb_os_write_stdout
;
307 gdb_callback
.flush_stdout
= gdb_os_flush_stdout
;
308 gdb_callback
.write_stderr
= gdb_os_write_stderr
;
309 gdb_callback
.flush_stderr
= gdb_os_flush_stderr
;
310 gdb_callback
.printf_filtered
= gdb_os_printf_filtered
;
311 gdb_callback
.vprintf_filtered
= gdb_os_vprintf_filtered
;
312 gdb_callback
.evprintf_filtered
= gdb_os_evprintf_filtered
;
313 gdb_callback
.error
= gdb_os_error
;
314 gdb_callback
.poll_quit
= gdb_os_poll_quit
;
315 gdb_callback
.magic
= HOST_CALLBACK_MAGIC
;
316 callbacks_initialized
= 1;
320 /* Release callbacks (free resources used by them). */
325 if (callbacks_initialized
)
327 gdb_callback
.shutdown (&gdb_callback
);
328 callbacks_initialized
= 0;
332 /* GDB version of os_write_stdout callback. */
335 gdb_os_write_stdout (host_callback
*p
, const char *buf
, int len
)
340 ui_file_write (gdb_stdtarg
, buf
, len
);
344 /* GDB version of os_flush_stdout callback. */
347 gdb_os_flush_stdout (host_callback
*p
)
349 gdb_flush (gdb_stdtarg
);
352 /* GDB version of os_write_stderr callback. */
355 gdb_os_write_stderr (host_callback
*p
, const char *buf
, int len
)
360 for (i
= 0; i
< len
; i
++)
364 fputs_unfiltered (b
, gdb_stdtargerr
);
369 /* GDB version of os_flush_stderr callback. */
372 gdb_os_flush_stderr (host_callback
*p
)
374 gdb_flush (gdb_stdtargerr
);
377 /* GDB version of printf_filtered callback. */
380 gdb_os_printf_filtered (host_callback
* p
, const char *format
,...)
384 va_start (args
, format
);
385 vfprintf_filtered (gdb_stdout
, format
, args
);
389 /* GDB version of error vprintf_filtered. */
392 gdb_os_vprintf_filtered (host_callback
* p
, const char *format
, va_list ap
)
394 vfprintf_filtered (gdb_stdout
, format
, ap
);
397 /* GDB version of error evprintf_filtered. */
400 gdb_os_evprintf_filtered (host_callback
* p
, const char *format
, va_list ap
)
402 vfprintf_filtered (gdb_stderr
, format
, ap
);
405 /* GDB version of error callback. */
408 gdb_os_error (host_callback
* p
, const char *format
, ...)
412 va_start (args
, format
);
413 verror (format
, args
);
418 one2one_register_sim_regno (struct gdbarch
*gdbarch
, int regnum
)
420 /* Only makes sense to supply raw registers. */
421 gdb_assert (regnum
>= 0 && regnum
< gdbarch_num_regs (gdbarch
));
426 gdbsim_fetch_register (struct target_ops
*ops
,
427 struct regcache
*regcache
, int regno
)
429 struct gdbarch
*gdbarch
= get_regcache_arch (regcache
);
430 struct sim_inferior_data
*sim_data
431 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED
);
435 for (regno
= 0; regno
< gdbarch_num_regs (gdbarch
); regno
++)
436 gdbsim_fetch_register (ops
, regcache
, regno
);
440 switch (gdbarch_register_sim_regno (gdbarch
, regno
))
442 case LEGACY_SIM_REGNO_IGNORE
:
444 case SIM_REGNO_DOES_NOT_EXIST
:
446 /* For moment treat a `does not exist' register the same way
447 as an ``unavailable'' register. */
448 gdb_byte buf
[MAX_REGISTER_SIZE
];
451 memset (buf
, 0, MAX_REGISTER_SIZE
);
452 regcache_raw_supply (regcache
, regno
, buf
);
458 static int warn_user
= 1;
459 gdb_byte buf
[MAX_REGISTER_SIZE
];
462 gdb_assert (regno
>= 0 && regno
< gdbarch_num_regs (gdbarch
));
463 memset (buf
, 0, MAX_REGISTER_SIZE
);
464 nr_bytes
= sim_fetch_register (sim_data
->gdbsim_desc
,
465 gdbarch_register_sim_regno
468 register_size (gdbarch
, regno
));
470 && nr_bytes
!= register_size (gdbarch
, regno
) && warn_user
)
472 fprintf_unfiltered (gdb_stderr
,
473 "Size of register %s (%d/%d) "
474 "incorrect (%d instead of %d))",
475 gdbarch_register_name (gdbarch
, regno
),
477 gdbarch_register_sim_regno
479 nr_bytes
, register_size (gdbarch
, regno
));
482 /* FIXME: cagney/2002-05-27: Should check `nr_bytes == 0'
483 indicating that GDB and the SIM have different ideas about
484 which registers are fetchable. */
485 /* Else if (nr_bytes < 0): an old simulator, that doesn't
486 think to return the register size. Just assume all is ok. */
487 regcache_raw_supply (regcache
, regno
, buf
);
490 fprintf_unfiltered (gdb_stdlog
,
491 "gdbsim_fetch_register: %d", regno
);
492 /* FIXME: We could print something more intelligible. */
493 dump_mem (buf
, register_size (gdbarch
, regno
));
502 gdbsim_store_register (struct target_ops
*ops
,
503 struct regcache
*regcache
, int regno
)
505 struct gdbarch
*gdbarch
= get_regcache_arch (regcache
);
506 struct sim_inferior_data
*sim_data
507 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED
);
511 for (regno
= 0; regno
< gdbarch_num_regs (gdbarch
); regno
++)
512 gdbsim_store_register (ops
, regcache
, regno
);
515 else if (gdbarch_register_sim_regno (gdbarch
, regno
) >= 0)
517 gdb_byte tmp
[MAX_REGISTER_SIZE
];
520 regcache_cooked_read (regcache
, regno
, tmp
);
521 nr_bytes
= sim_store_register (sim_data
->gdbsim_desc
,
522 gdbarch_register_sim_regno
524 tmp
, register_size (gdbarch
, regno
));
525 if (nr_bytes
> 0 && nr_bytes
!= register_size (gdbarch
, regno
))
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
, register_size (gdbarch
, regno
));
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 ();
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 (char *args
, int fromtty
)
567 struct sim_inferior_data
*sim_data
568 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED
);
571 error_no_arg (_("program to load"));
573 argv
= gdb_buildargv (args
);
574 make_cleanup_freeargv (argv
);
576 prog
= tilde_expand (argv
[0]);
579 error (_("GDB sim does not yet support a load offset."));
582 fprintf_unfiltered (gdb_stdlog
, "gdbsim_load: prog \"%s\"\n", prog
);
584 /* FIXME: We will print two messages on error.
585 Need error to either not print anything if passed NULL or need
586 another routine that doesn't take any arguments. */
587 if (sim_load (sim_data
->gdbsim_desc
, prog
, NULL
, fromtty
) == SIM_RC_FAIL
)
588 error (_("unable to load program"));
590 /* FIXME: If a load command should reset the targets registers then
591 a call to sim_create_inferior() should go here. */
593 sim_data
->program_loaded
= 1;
597 /* Start an inferior process and set inferior_ptid to its pid.
598 EXEC_FILE is the file to run.
599 ARGS is a string containing the arguments to the program.
600 ENV is the environment vector to pass. Errors reported with error().
601 On VxWorks and various standalone systems, we ignore exec_file. */
602 /* This is called not only when we first attach, but also when the
603 user types "run" after having attached. */
606 gdbsim_create_inferior (struct target_ops
*target
, char *exec_file
, char *args
,
607 char **env
, int from_tty
)
609 struct sim_inferior_data
*sim_data
610 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED
);
612 char *arg_buf
, **argv
;
614 if (exec_file
== 0 || exec_bfd
== 0)
615 warning (_("No executable file specified."));
616 if (!sim_data
->program_loaded
)
617 warning (_("No program loaded."));
620 fprintf_unfiltered (gdb_stdlog
,
621 "gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
622 (exec_file
? exec_file
: "(NULL)"),
625 if (ptid_equal (inferior_ptid
, sim_data
->remote_sim_ptid
))
626 gdbsim_kill (target
);
627 remove_breakpoints ();
628 init_wait_for_inferior ();
630 if (exec_file
!= NULL
)
632 len
= strlen (exec_file
) + 1 + strlen (args
) + 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 argv
= gdb_buildargv (arg_buf
);
639 make_cleanup_freeargv (argv
);
644 if (!have_inferiors ())
647 if (sim_create_inferior (sim_data
->gdbsim_desc
, exec_bfd
, argv
, env
)
649 error (_("Unable to create sim inferior."));
651 inferior_ptid
= sim_data
->remote_sim_ptid
;
652 inferior_appeared (current_inferior (), ptid_get_pid (inferior_ptid
));
653 add_thread_silent (inferior_ptid
);
655 insert_breakpoints (); /* Needed to get correct instruction
658 clear_proceed_status ();
661 /* The open routine takes the rest of the parameters from the command,
662 and (if successful) pushes a new target onto the stack.
663 Targets should supply this routine, if only to provide an error message. */
664 /* Called when selecting the simulator. E.g. (gdb) target sim name. */
667 gdbsim_open (char *args
, int from_tty
)
671 struct sim_inferior_data
*sim_data
;
672 SIM_DESC gdbsim_desc
;
675 fprintf_unfiltered (gdb_stdlog
,
676 "gdbsim_open: args \"%s\"\n", args
? args
: "(null)");
678 /* Ensure that the sim target is not on the target stack. This is
679 necessary, because if it is on the target stack, the call to
680 push_target below will invoke sim_close(), thus freeing various
681 state (including a sim instance) that we allocate prior to
682 invoking push_target(). We want to delay the push_target()
683 operation until after we complete those operations which could
686 unpush_target (&gdbsim_ops
);
688 len
= (7 + 1 /* gdbsim */
689 + strlen (" -E little")
690 + strlen (" --architecture=xxxxxxxxxx")
691 + strlen (" --sysroot=") + strlen (gdb_sysroot
) +
692 + (args
? strlen (args
) : 0)
694 arg_buf
= (char *) alloca (len
);
695 strcpy (arg_buf
, "gdbsim"); /* 7 */
696 /* Specify the byte order for the target when it is explicitly
697 specified by the user (not auto detected). */
698 switch (selected_byte_order ())
701 strcat (arg_buf
, " -E big");
703 case BFD_ENDIAN_LITTLE
:
704 strcat (arg_buf
, " -E little");
706 case BFD_ENDIAN_UNKNOWN
:
709 /* Specify the architecture of the target when it has been
710 explicitly specified */
711 if (selected_architecture_name () != NULL
)
713 strcat (arg_buf
, " --architecture=");
714 strcat (arg_buf
, selected_architecture_name ());
716 /* Pass along gdb's concept of the sysroot. */
717 strcat (arg_buf
, " --sysroot=");
718 strcat (arg_buf
, gdb_sysroot
);
719 /* finally, any explicit args */
722 strcat (arg_buf
, " "); /* 1 */
723 strcat (arg_buf
, args
);
725 sim_argv
= gdb_buildargv (arg_buf
);
728 gdbsim_desc
= sim_open (SIM_OPEN_DEBUG
, &gdb_callback
, exec_bfd
, sim_argv
);
730 if (gdbsim_desc
== 0)
734 error (_("unable to create simulator instance"));
737 /* Reset the pid numberings for this batch of sim instances. */
738 next_pid
= INITIAL_PID
;
740 /* Allocate the inferior data, but do not allocate a sim instance
741 since we've already just done that. */
742 sim_data
= get_sim_inferior_data (current_inferior (),
743 SIM_INSTANCE_NOT_NEEDED
);
745 sim_data
->gdbsim_desc
= gdbsim_desc
;
747 push_target (&gdbsim_ops
);
748 printf_filtered ("Connected to the simulator.\n");
750 /* There's nothing running after "target sim" or "load"; not until
752 inferior_ptid
= null_ptid
;
757 /* Callback for iterate_over_inferiors. Called (indirectly) by
761 gdbsim_close_inferior (struct inferior
*inf
, void *arg
)
763 struct sim_inferior_data
*sim_data
= inferior_data (inf
,
764 sim_inferior_data_key
);
765 if (sim_data
!= NULL
)
767 ptid_t ptid
= sim_data
->remote_sim_ptid
;
769 sim_inferior_data_cleanup (inf
, sim_data
);
770 set_inferior_data (inf
, sim_inferior_data_key
, NULL
);
772 /* Having a ptid allocated and stored in remote_sim_ptid does
773 not mean that a corresponding inferior was ever created.
774 Thus we need to verify the existence of an inferior using the
775 pid in question before setting inferior_ptid via
776 switch_to_thread() or mourning the inferior. */
777 if (find_inferior_pid (ptid_get_pid (ptid
)) != NULL
)
779 switch_to_thread (ptid
);
780 generic_mourn_inferior ();
787 /* Close out all files and local state before this target loses control. */
792 struct sim_inferior_data
*sim_data
793 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
796 fprintf_unfiltered (gdb_stdlog
, "gdbsim_close\n");
798 iterate_over_inferiors (gdbsim_close_inferior
, NULL
);
800 if (sim_argv
!= NULL
)
811 /* Takes a program previously attached to and detaches it.
812 The program may resume execution (some targets do, some don't) and will
813 no longer stop on signals, etc. We better not have left any breakpoints
814 in the program or it'll die when it hits one. ARGS is arguments
815 typed by the user (e.g. a signal to send the process). FROM_TTY
816 says whether to be verbose or not. */
817 /* Terminate the open connection to the remote debugger.
818 Use this when you want to detach and do something else with your gdb. */
821 gdbsim_detach (struct target_ops
*ops
, const char *args
, int from_tty
)
824 fprintf_unfiltered (gdb_stdlog
, "gdbsim_detach: args \"%s\"\n", args
);
826 unpush_target (ops
); /* calls gdbsim_close to do the real work */
828 printf_filtered ("Ending simulator %s debugging\n", target_shortname
);
831 /* Resume execution of the target process. STEP says whether to single-step
832 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
833 to the target, or zero for no signal. */
837 enum gdb_signal siggnal
;
842 gdbsim_resume_inferior (struct inferior
*inf
, void *arg
)
844 struct sim_inferior_data
*sim_data
845 = get_sim_inferior_data (inf
, SIM_INSTANCE_NOT_NEEDED
);
846 struct resume_data
*rd
= arg
;
850 sim_data
->resume_siggnal
= rd
->siggnal
;
851 sim_data
->resume_step
= rd
->step
;
854 fprintf_unfiltered (gdb_stdlog
,
855 _("gdbsim_resume: pid %d, step %d, signal %d\n"),
856 inf
->pid
, rd
->step
, rd
->siggnal
);
859 /* When called from iterate_over_inferiors, a zero return causes the
860 iteration process to proceed until there are no more inferiors to
866 gdbsim_resume (struct target_ops
*ops
,
867 ptid_t ptid
, int step
, enum gdb_signal siggnal
)
869 struct resume_data rd
;
870 struct sim_inferior_data
*sim_data
871 = get_sim_inferior_data_by_ptid (ptid
, SIM_INSTANCE_NOT_NEEDED
);
873 rd
.siggnal
= siggnal
;
876 /* We don't access any sim_data members within this function.
877 What's of interest is whether or not the call to
878 get_sim_inferior_data_by_ptid(), above, is able to obtain a
879 non-NULL pointer. If it managed to obtain a non-NULL pointer, we
880 know we have a single inferior to consider. If it's NULL, we
881 either have multiple inferiors to resume or an error condition. */
884 gdbsim_resume_inferior (find_inferior_pid (ptid_get_pid (ptid
)), &rd
);
885 else if (ptid_equal (ptid
, minus_one_ptid
))
886 iterate_over_inferiors (gdbsim_resume_inferior
, &rd
);
888 error (_("The program is not being run."));
891 /* Notify the simulator of an asynchronous request to stop.
893 The simulator shall ensure that the stop request is eventually
894 delivered to the simulator. If the call is made while the
895 simulator is not running then the stop request is processed when
896 the simulator is next resumed.
898 For simulators that do not support this operation, just abort. */
901 gdbsim_stop_inferior (struct inferior
*inf
, void *arg
)
903 struct sim_inferior_data
*sim_data
904 = get_sim_inferior_data (inf
, SIM_INSTANCE_NEEDED
);
908 if (!sim_stop (sim_data
->gdbsim_desc
))
914 /* When called from iterate_over_inferiors, a zero return causes the
915 iteration process to proceed until there are no more inferiors to
921 gdbsim_stop (ptid_t ptid
)
923 struct sim_inferior_data
*sim_data
;
925 if (ptid_equal (ptid
, minus_one_ptid
))
927 iterate_over_inferiors (gdbsim_stop_inferior
, NULL
);
931 struct inferior
*inf
= find_inferior_pid (ptid_get_pid (ptid
));
934 error (_("Can't stop pid %d. No inferior found."),
935 ptid_get_pid (ptid
));
937 gdbsim_stop_inferior (inf
, NULL
);
941 /* GDB version of os_poll_quit callback.
942 Taken from gdb/util.c - should be in a library. */
945 gdb_os_poll_quit (host_callback
*p
)
947 if (deprecated_ui_loop_hook
!= NULL
)
948 deprecated_ui_loop_hook (0);
950 if (check_quit_flag ()) /* gdb's idea of quit */
952 clear_quit_flag (); /* we've stolen it */
958 /* Wait for inferior process to do something. Return pid of child,
959 or -1 in case of error; store status through argument pointer STATUS,
960 just as `wait' would. */
963 gdbsim_cntrl_c (int signo
)
965 gdbsim_stop (minus_one_ptid
);
969 gdbsim_wait (struct target_ops
*ops
,
970 ptid_t ptid
, struct target_waitstatus
*status
, int options
)
972 struct sim_inferior_data
*sim_data
;
973 static RETSIGTYPE (*prev_sigint
) ();
975 enum sim_stop reason
= sim_running
;
977 /* This target isn't able to (yet) resume more than one inferior at a time.
978 When ptid is minus_one_ptid, just use the current inferior. If we're
979 given an explicit pid, we'll try to find it and use that instead. */
980 if (ptid_equal (ptid
, minus_one_ptid
))
981 sim_data
= get_sim_inferior_data (current_inferior (),
982 SIM_INSTANCE_NEEDED
);
985 sim_data
= get_sim_inferior_data_by_ptid (ptid
, SIM_INSTANCE_NEEDED
);
986 if (sim_data
== NULL
)
987 error (_("Unable to wait for pid %d. Inferior not found."),
988 ptid_get_pid (ptid
));
989 inferior_ptid
= ptid
;
993 fprintf_unfiltered (gdb_stdlog
, "gdbsim_wait\n");
995 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
997 struct sigaction sa
, osa
;
998 sa
.sa_handler
= gdbsim_cntrl_c
;
999 sigemptyset (&sa
.sa_mask
);
1001 sigaction (SIGINT
, &sa
, &osa
);
1002 prev_sigint
= osa
.sa_handler
;
1005 prev_sigint
= signal (SIGINT
, gdbsim_cntrl_c
);
1007 sim_resume (sim_data
->gdbsim_desc
, sim_data
->resume_step
,
1008 sim_data
->resume_siggnal
);
1010 signal (SIGINT
, prev_sigint
);
1011 sim_data
->resume_step
= 0;
1013 sim_stop_reason (sim_data
->gdbsim_desc
, &reason
, &sigrc
);
1018 status
->kind
= TARGET_WAITKIND_EXITED
;
1019 status
->value
.integer
= sigrc
;
1024 case GDB_SIGNAL_ABRT
:
1027 case GDB_SIGNAL_INT
:
1028 case GDB_SIGNAL_TRAP
:
1030 status
->kind
= TARGET_WAITKIND_STOPPED
;
1031 status
->value
.sig
= sigrc
;
1036 status
->kind
= TARGET_WAITKIND_SIGNALLED
;
1037 status
->value
.sig
= sigrc
;
1041 /* FIXME: Is this correct? */
1045 return inferior_ptid
;
1048 /* Get ready to modify the registers array. On machines which store
1049 individual registers, this doesn't need to do anything. On machines
1050 which store all the registers in one fell swoop, this makes sure
1051 that registers contains all the registers from the program being
1055 gdbsim_prepare_to_store (struct regcache
*regcache
)
1057 /* Do nothing, since we can store individual regs. */
1060 /* Helper for gdbsim_xfer_partial that handles memory transfers.
1061 Arguments are like target_xfer_partial. */
1064 gdbsim_xfer_memory (struct target_ops
*target
,
1065 gdb_byte
*readbuf
, const gdb_byte
*writebuf
,
1066 ULONGEST memaddr
, LONGEST len
)
1068 struct sim_inferior_data
*sim_data
1069 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
1071 /* If this target doesn't have memory yet, return 0 causing the
1072 request to be passed to a lower target, hopefully an exec
1074 if (!target
->to_has_memory (target
))
1077 if (!sim_data
->program_loaded
)
1078 error (_("No program loaded."));
1080 /* Note that we obtained the sim_data pointer above using
1081 SIM_INSTANCE_NOT_NEEDED. We do this so that we don't needlessly
1082 allocate a sim instance prior to loading a program. If we
1083 get to this point in the code though, gdbsim_desc should be
1084 non-NULL. (Note that a sim instance is needed in order to load
1086 gdb_assert (sim_data
->gdbsim_desc
!= NULL
);
1089 fprintf_unfiltered (gdb_stdlog
,
1090 "gdbsim_xfer_memory: readbuf %s, writebuf %s, "
1091 "memaddr %s, len %s\n",
1092 host_address_to_string (readbuf
),
1093 host_address_to_string (writebuf
),
1094 paddress (target_gdbarch (), memaddr
),
1099 if (remote_debug
&& len
> 0)
1100 dump_mem (writebuf
, len
);
1101 len
= sim_write (sim_data
->gdbsim_desc
, memaddr
, writebuf
, len
);
1105 len
= sim_read (sim_data
->gdbsim_desc
, memaddr
, readbuf
, len
);
1106 if (remote_debug
&& len
> 0)
1107 dump_mem (readbuf
, len
);
1112 /* Target to_xfer_partial implementation. */
1115 gdbsim_xfer_partial (struct target_ops
*ops
, enum target_object object
,
1116 const char *annex
, gdb_byte
*readbuf
,
1117 const gdb_byte
*writebuf
, ULONGEST offset
, LONGEST len
)
1121 case TARGET_OBJECT_MEMORY
:
1122 return gdbsim_xfer_memory (ops
, readbuf
, writebuf
, offset
, len
);
1130 gdbsim_files_info (struct target_ops
*target
)
1132 struct sim_inferior_data
*sim_data
1133 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED
);
1134 const char *file
= "nothing";
1137 file
= bfd_get_filename (exec_bfd
);
1140 fprintf_unfiltered (gdb_stdlog
, "gdbsim_files_info: file \"%s\"\n", file
);
1144 fprintf_unfiltered (gdb_stdlog
, "\tAttached to %s running program %s\n",
1145 target_shortname
, file
);
1146 sim_info (sim_data
->gdbsim_desc
, 0);
1150 /* Clear the simulator's notion of what the break points are. */
1153 gdbsim_mourn_inferior (struct target_ops
*target
)
1155 struct sim_inferior_data
*sim_data
1156 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
1159 fprintf_unfiltered (gdb_stdlog
, "gdbsim_mourn_inferior:\n");
1161 remove_breakpoints ();
1162 generic_mourn_inferior ();
1163 delete_thread_silent (sim_data
->remote_sim_ptid
);
1166 /* Pass the command argument through to the simulator verbatim. The
1167 simulator must do any command interpretation work. */
1170 simulator_command (char *args
, int from_tty
)
1172 struct sim_inferior_data
*sim_data
;
1174 /* We use inferior_data() instead of get_sim_inferior_data() here in
1175 order to avoid attaching a sim_inferior_data struct to an
1176 inferior unnecessarily. The reason we take such care here is due
1177 to the fact that this function, simulator_command(), may be called
1178 even when the sim target is not active. If we were to use
1179 get_sim_inferior_data() here, it is possible that this call would
1180 be made either prior to gdbsim_open() or after gdbsim_close(),
1181 thus allocating memory that would not be garbage collected until
1182 the ultimate destruction of the associated inferior. */
1184 sim_data
= inferior_data (current_inferior (), sim_inferior_data_key
);
1185 if (sim_data
== NULL
|| sim_data
->gdbsim_desc
== NULL
)
1188 /* PREVIOUSLY: The user may give a command before the simulator
1189 is opened. [...] (??? assuming of course one wishes to
1190 continue to allow commands to be sent to unopened simulators,
1191 which isn't entirely unreasonable). */
1193 /* The simulator is a builtin abstraction of a remote target.
1194 Consistent with that model, access to the simulator, via sim
1195 commands, is restricted to the period when the channel to the
1196 simulator is open. */
1198 error (_("Not connected to the simulator target"));
1201 sim_do_command (sim_data
->gdbsim_desc
, args
);
1203 /* Invalidate the register cache, in case the simulator command does
1205 registers_changed ();
1208 static VEC (char_ptr
) *
1209 sim_command_completer (struct cmd_list_element
*ignore
, const char *text
,
1212 struct sim_inferior_data
*sim_data
;
1215 VEC (char_ptr
) *result
= NULL
;
1217 sim_data
= inferior_data (current_inferior (), sim_inferior_data_key
);
1218 if (sim_data
== NULL
|| sim_data
->gdbsim_desc
== NULL
)
1221 tmp
= sim_complete_command (sim_data
->gdbsim_desc
, text
, word
);
1225 /* Transform the array into a VEC, and then free the array. */
1226 for (i
= 0; tmp
[i
] != NULL
; i
++)
1227 VEC_safe_push (char_ptr
, result
, tmp
[i
]);
1233 /* Check to see if a thread is still alive. */
1236 gdbsim_thread_alive (struct target_ops
*ops
, ptid_t ptid
)
1238 struct sim_inferior_data
*sim_data
1239 = get_sim_inferior_data_by_ptid (ptid
, SIM_INSTANCE_NOT_NEEDED
);
1241 if (sim_data
== NULL
)
1244 if (ptid_equal (ptid
, sim_data
->remote_sim_ptid
))
1245 /* The simulators' task is always alive. */
1251 /* Convert a thread ID to a string. Returns the string in a static
1255 gdbsim_pid_to_str (struct target_ops
*ops
, ptid_t ptid
)
1257 return normal_pid_to_str (ptid
);
1260 /* Simulator memory may be accessed after the program has been loaded. */
1263 gdbsim_has_all_memory (struct target_ops
*ops
)
1265 struct sim_inferior_data
*sim_data
1266 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
1268 if (!sim_data
->program_loaded
)
1275 gdbsim_has_memory (struct target_ops
*ops
)
1277 struct sim_inferior_data
*sim_data
1278 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED
);
1280 if (!sim_data
->program_loaded
)
1286 /* Define the target subroutine names. */
1288 struct target_ops gdbsim_ops
;
1291 init_gdbsim_ops (void)
1293 gdbsim_ops
.to_shortname
= "sim";
1294 gdbsim_ops
.to_longname
= "simulator";
1295 gdbsim_ops
.to_doc
= "Use the compiled-in simulator.";
1296 gdbsim_ops
.to_open
= gdbsim_open
;
1297 gdbsim_ops
.to_close
= gdbsim_close
;
1298 gdbsim_ops
.to_detach
= gdbsim_detach
;
1299 gdbsim_ops
.to_resume
= gdbsim_resume
;
1300 gdbsim_ops
.to_wait
= gdbsim_wait
;
1301 gdbsim_ops
.to_fetch_registers
= gdbsim_fetch_register
;
1302 gdbsim_ops
.to_store_registers
= gdbsim_store_register
;
1303 gdbsim_ops
.to_prepare_to_store
= gdbsim_prepare_to_store
;
1304 gdbsim_ops
.to_xfer_partial
= gdbsim_xfer_partial
;
1305 gdbsim_ops
.to_files_info
= gdbsim_files_info
;
1306 gdbsim_ops
.to_insert_breakpoint
= memory_insert_breakpoint
;
1307 gdbsim_ops
.to_remove_breakpoint
= memory_remove_breakpoint
;
1308 gdbsim_ops
.to_kill
= gdbsim_kill
;
1309 gdbsim_ops
.to_load
= gdbsim_load
;
1310 gdbsim_ops
.to_create_inferior
= gdbsim_create_inferior
;
1311 gdbsim_ops
.to_mourn_inferior
= gdbsim_mourn_inferior
;
1312 gdbsim_ops
.to_stop
= gdbsim_stop
;
1313 gdbsim_ops
.to_thread_alive
= gdbsim_thread_alive
;
1314 gdbsim_ops
.to_pid_to_str
= gdbsim_pid_to_str
;
1315 gdbsim_ops
.to_stratum
= process_stratum
;
1316 gdbsim_ops
.to_has_all_memory
= gdbsim_has_all_memory
;
1317 gdbsim_ops
.to_has_memory
= gdbsim_has_memory
;
1318 gdbsim_ops
.to_has_stack
= default_child_has_stack
;
1319 gdbsim_ops
.to_has_registers
= default_child_has_registers
;
1320 gdbsim_ops
.to_has_execution
= default_child_has_execution
;
1321 gdbsim_ops
.to_magic
= OPS_MAGIC
;
1325 _initialize_remote_sim (void)
1327 struct cmd_list_element
*c
;
1330 add_target (&gdbsim_ops
);
1332 c
= add_com ("sim", class_obscure
, simulator_command
,
1333 _("Send a command to the simulator."));
1334 set_cmd_completer (c
, sim_command_completer
);
1336 sim_inferior_data_key
1337 = register_inferior_data_with_cleanup (NULL
, sim_inferior_data_cleanup
);