1 /* Generic remote debugging interface for simulators.
3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 Free Software Foundation, Inc.
7 Contributed by Cygnus Support.
8 Steve Chamberlain (sac@cygnus.com).
10 This file is part of GDB.
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 3 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 #include "gdb_string.h"
37 #include "gdb/callback.h"
38 #include "gdb/remote-sim.h"
41 #include "gdb_assert.h"
42 #include "sim-regno.h"
43 #include "arch-utils.h"
44 #include "readline/readline.h"
45 #include "gdbthread.h"
49 extern void _initialize_remote_sim (void);
51 static void dump_mem (char *buf, int len);
53 static void init_callbacks (void);
55 static void end_callbacks (void);
57 static int gdb_os_write_stdout (host_callback *, const char *, int);
59 static void gdb_os_flush_stdout (host_callback *);
61 static int gdb_os_write_stderr (host_callback *, const char *, int);
63 static void gdb_os_flush_stderr (host_callback *);
65 static int gdb_os_poll_quit (host_callback *);
67 /* printf_filtered is depreciated. */
68 static void gdb_os_printf_filtered (host_callback *, const char *, ...);
70 static void gdb_os_vprintf_filtered (host_callback *, const char *, va_list);
72 static void gdb_os_evprintf_filtered (host_callback *, const char *, va_list);
74 static void gdb_os_error (host_callback *, const char *, ...)
77 static void gdbsim_kill (struct target_ops *);
79 static void gdbsim_load (char *prog, int fromtty);
81 static void gdbsim_open (char *args, int from_tty);
83 static void gdbsim_close (int quitting);
85 static void gdbsim_detach (struct target_ops *ops, char *args, int from_tty);
87 static void gdbsim_prepare_to_store (struct regcache *regcache);
89 static void gdbsim_files_info (struct target_ops *target);
91 static void gdbsim_mourn_inferior (struct target_ops *target);
93 static void gdbsim_stop (ptid_t ptid);
95 void simulator_command (char *args, int from_tty);
99 sim_* are the interface to the simulator (see remote-sim.h).
100 gdbsim_* are stuff which is internal to gdb. */
102 /* Forward data declarations */
103 extern struct target_ops gdbsim_ops;
105 static const struct inferior_data *sim_inferior_data_key;
107 /* Simulator-specific, per-inferior state. */
108 struct sim_inferior_data {
109 /* Flag which indicates whether or not the program has been loaded. */
112 /* Simulator descriptor for this inferior. */
113 SIM_DESC gdbsim_desc;
115 /* This is the ptid we use for this particular simulator instance. Its
116 value is somewhat arbitrary, as the simulator target don't have a
117 notion of tasks or threads, but we need something non-null to place
118 in inferior_ptid. For simulators which permit multiple instances,
119 we also need a unique identifier to use for each inferior. */
120 ptid_t remote_sim_ptid;
122 /* Signal with which to resume. */
123 enum target_signal resume_siggnal;
125 /* Flag which indicates whether resume should step or not. */
129 /* Flag indicating the "open" status of this module. It's set to 1
130 in gdbsim_open() and 0 in gdbsim_close(). */
131 static int gdbsim_is_open = 0;
133 /* Value of the next pid to allocate for an inferior. As indicated
134 elsewhere, its initial value is somewhat arbitrary; it's critical
135 though that it's not zero or negative. */
137 #define INITIAL_PID 42000
139 /* Argument list to pass to sim_open(). It is allocated in gdbsim_open()
140 and deallocated in gdbsim_close(). The lifetime needs to extend beyond
141 the call to gdbsim_open() due to the fact that other sim instances other
142 than the first will be allocated after the gdbsim_open() call. */
143 static char **sim_argv = NULL;
145 /* OS-level callback functions for write, flush, etc. */
146 static host_callback gdb_callback;
147 static int callbacks_initialized = 0;
149 /* Callback for iterate_over_inferiors. It checks to see if the sim
150 descriptor passed via ARG is the same as that for the inferior
151 designated by INF. Return true if so; false otherwise. */
154 check_for_duplicate_sim_descriptor (struct inferior *inf, void *arg)
156 struct sim_inferior_data *sim_data;
157 SIM_DESC new_sim_desc = arg;
159 sim_data = 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 = 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 = XZALLOC(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 = TARGET_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 = 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 (char *buf, int len)
280 if (len == 8 || len == 4)
284 memcpy (l, buf, len);
285 printf_filtered ("\t0x%lx", l[0]);
287 printf_filtered (" 0x%lx", l[1]);
288 printf_filtered ("\n");
294 printf_filtered ("\t");
295 for (i = 0; i < len; i++)
296 printf_filtered ("0x%x ", buf[i]);
297 printf_filtered ("\n");
302 /* Initialize gdb_callback. */
305 init_callbacks (void)
307 if (!callbacks_initialized)
309 gdb_callback = default_callback;
310 gdb_callback.init (&gdb_callback);
311 gdb_callback.write_stdout = gdb_os_write_stdout;
312 gdb_callback.flush_stdout = gdb_os_flush_stdout;
313 gdb_callback.write_stderr = gdb_os_write_stderr;
314 gdb_callback.flush_stderr = gdb_os_flush_stderr;
315 gdb_callback.printf_filtered = gdb_os_printf_filtered;
316 gdb_callback.vprintf_filtered = gdb_os_vprintf_filtered;
317 gdb_callback.evprintf_filtered = gdb_os_evprintf_filtered;
318 gdb_callback.error = gdb_os_error;
319 gdb_callback.poll_quit = gdb_os_poll_quit;
320 gdb_callback.magic = HOST_CALLBACK_MAGIC;
321 callbacks_initialized = 1;
325 /* Release callbacks (free resources used by them). */
330 if (callbacks_initialized)
332 gdb_callback.shutdown (&gdb_callback);
333 callbacks_initialized = 0;
337 /* GDB version of os_write_stdout callback. */
340 gdb_os_write_stdout (host_callback *p, const char *buf, int len)
345 ui_file_write (gdb_stdtarg, buf, len);
349 /* GDB version of os_flush_stdout callback. */
352 gdb_os_flush_stdout (host_callback *p)
354 gdb_flush (gdb_stdtarg);
357 /* GDB version of os_write_stderr callback. */
360 gdb_os_write_stderr (host_callback *p, const char *buf, int len)
365 for (i = 0; i < len; i++)
369 fputs_unfiltered (b, gdb_stdtargerr);
374 /* GDB version of os_flush_stderr callback. */
377 gdb_os_flush_stderr (host_callback *p)
379 gdb_flush (gdb_stdtargerr);
382 /* GDB version of printf_filtered callback. */
385 gdb_os_printf_filtered (host_callback * p, const char *format,...)
389 va_start (args, format);
390 vfprintf_filtered (gdb_stdout, format, args);
394 /* GDB version of error vprintf_filtered. */
397 gdb_os_vprintf_filtered (host_callback * p, const char *format, va_list ap)
399 vfprintf_filtered (gdb_stdout, format, ap);
402 /* GDB version of error evprintf_filtered. */
405 gdb_os_evprintf_filtered (host_callback * p, const char *format, va_list ap)
407 vfprintf_filtered (gdb_stderr, format, ap);
410 /* GDB version of error callback. */
413 gdb_os_error (host_callback * p, const char *format, ...)
417 va_start (args, format);
418 verror (format, args);
423 one2one_register_sim_regno (struct gdbarch *gdbarch, int regnum)
425 /* Only makes sense to supply raw registers. */
426 gdb_assert (regnum >= 0 && regnum < gdbarch_num_regs (gdbarch));
431 gdbsim_fetch_register (struct target_ops *ops,
432 struct regcache *regcache, int regno)
434 struct gdbarch *gdbarch = get_regcache_arch (regcache);
435 struct sim_inferior_data *sim_data
436 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED);
440 for (regno = 0; regno < gdbarch_num_regs (gdbarch); regno++)
441 gdbsim_fetch_register (ops, regcache, regno);
445 switch (gdbarch_register_sim_regno (gdbarch, regno))
447 case LEGACY_SIM_REGNO_IGNORE:
449 case SIM_REGNO_DOES_NOT_EXIST:
451 /* For moment treat a `does not exist' register the same way
452 as an ``unavailable'' register. */
453 char buf[MAX_REGISTER_SIZE];
456 memset (buf, 0, MAX_REGISTER_SIZE);
457 regcache_raw_supply (regcache, regno, buf);
463 static int warn_user = 1;
464 char buf[MAX_REGISTER_SIZE];
467 gdb_assert (regno >= 0 && regno < gdbarch_num_regs (gdbarch));
468 memset (buf, 0, MAX_REGISTER_SIZE);
469 nr_bytes = sim_fetch_register (sim_data->gdbsim_desc,
470 gdbarch_register_sim_regno
473 register_size (gdbarch, regno));
475 && nr_bytes != register_size (gdbarch, regno) && warn_user)
477 fprintf_unfiltered (gdb_stderr,
478 "Size of register %s (%d/%d) "
479 "incorrect (%d instead of %d))",
480 gdbarch_register_name (gdbarch, regno),
482 gdbarch_register_sim_regno
484 nr_bytes, register_size (gdbarch, regno));
487 /* FIXME: cagney/2002-05-27: Should check `nr_bytes == 0'
488 indicating that GDB and the SIM have different ideas about
489 which registers are fetchable. */
490 /* Else if (nr_bytes < 0): an old simulator, that doesn't
491 think to return the register size. Just assume all is ok. */
492 regcache_raw_supply (regcache, regno, buf);
495 printf_filtered ("gdbsim_fetch_register: %d", regno);
496 /* FIXME: We could print something more intelligible. */
497 dump_mem (buf, register_size (gdbarch, regno));
506 gdbsim_store_register (struct target_ops *ops,
507 struct regcache *regcache, int regno)
509 struct gdbarch *gdbarch = get_regcache_arch (regcache);
510 struct sim_inferior_data *sim_data
511 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED);
515 for (regno = 0; regno < gdbarch_num_regs (gdbarch); regno++)
516 gdbsim_store_register (ops, regcache, regno);
519 else if (gdbarch_register_sim_regno (gdbarch, regno) >= 0)
521 char tmp[MAX_REGISTER_SIZE];
524 regcache_cooked_read (regcache, regno, tmp);
525 nr_bytes = sim_store_register (sim_data->gdbsim_desc,
526 gdbarch_register_sim_regno
528 tmp, register_size (gdbarch, regno));
529 if (nr_bytes > 0 && nr_bytes != register_size (gdbarch, regno))
530 internal_error (__FILE__, __LINE__,
531 _("Register size different to expected"));
533 internal_error (__FILE__, __LINE__,
534 _("Register %d not updated"), regno);
536 warning (_("Register %s not updated"),
537 gdbarch_register_name (gdbarch, regno));
541 printf_filtered ("gdbsim_store_register: %d", regno);
542 /* FIXME: We could print something more intelligible. */
543 dump_mem (tmp, register_size (gdbarch, regno));
548 /* Kill the running program. This may involve closing any open files
549 and releasing other resources acquired by the simulated program. */
552 gdbsim_kill (struct target_ops *ops)
555 printf_filtered ("gdbsim_kill\n");
557 /* There is no need to `kill' running simulator - the simulator is
558 not running. Mourning it is enough. */
559 target_mourn_inferior ();
562 /* Load an executable file into the target process. This is expected to
563 not only bring new code into the target process, but also to update
564 GDB's symbol tables to match. */
567 gdbsim_load (char *args, int fromtty)
571 struct sim_inferior_data *sim_data
572 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED);
575 error_no_arg (_("program to load"));
577 argv = gdb_buildargv (args);
578 make_cleanup_freeargv (argv);
580 prog = tilde_expand (argv[0]);
583 error (_("GDB sim does not yet support a load offset."));
586 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog);
588 /* FIXME: We will print two messages on error.
589 Need error to either not print anything if passed NULL or need
590 another routine that doesn't take any arguments. */
591 if (sim_load (sim_data->gdbsim_desc, prog, NULL, fromtty) == SIM_RC_FAIL)
592 error (_("unable to load program"));
594 /* FIXME: If a load command should reset the targets registers then
595 a call to sim_create_inferior() should go here. */
597 sim_data->program_loaded = 1;
601 /* Start an inferior process and set inferior_ptid to its pid.
602 EXEC_FILE is the file to run.
603 ARGS is a string containing the arguments to the program.
604 ENV is the environment vector to pass. Errors reported with error().
605 On VxWorks and various standalone systems, we ignore exec_file. */
606 /* This is called not only when we first attach, but also when the
607 user types "run" after having attached. */
610 gdbsim_create_inferior (struct target_ops *target, char *exec_file, char *args,
611 char **env, int from_tty)
613 struct sim_inferior_data *sim_data
614 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED);
616 char *arg_buf, **argv;
618 if (exec_file == 0 || exec_bfd == 0)
619 warning (_("No executable file specified."));
620 if (!sim_data->program_loaded)
621 warning (_("No program loaded."));
624 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
625 (exec_file ? exec_file : "(NULL)"),
628 if (ptid_equal (inferior_ptid, sim_data->remote_sim_ptid))
629 gdbsim_kill (target);
630 remove_breakpoints ();
631 init_wait_for_inferior ();
633 if (exec_file != NULL)
635 len = strlen (exec_file) + 1 + strlen (args) + 1 + /*slop */ 10;
636 arg_buf = (char *) alloca (len);
638 strcat (arg_buf, exec_file);
639 strcat (arg_buf, " ");
640 strcat (arg_buf, args);
641 argv = gdb_buildargv (arg_buf);
642 make_cleanup_freeargv (argv);
646 sim_create_inferior (sim_data->gdbsim_desc, exec_bfd, argv, env);
648 inferior_ptid = sim_data->remote_sim_ptid;
649 inferior_appeared (current_inferior (), ptid_get_pid (inferior_ptid));
650 add_thread_silent (inferior_ptid);
652 insert_breakpoints (); /* Needed to get correct instruction
655 clear_proceed_status ();
658 /* The open routine takes the rest of the parameters from the command,
659 and (if successful) pushes a new target onto the stack.
660 Targets should supply this routine, if only to provide an error message. */
661 /* Called when selecting the simulator. E.g. (gdb) target sim name. */
664 gdbsim_open (char *args, int from_tty)
668 struct sim_inferior_data *sim_data;
669 SIM_DESC gdbsim_desc;
672 printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
674 /* Ensure that the sim target is not on the target stack. This is
675 necessary, because if it is on the target stack, the call to
676 push_target below will invoke sim_close(), thus freeing various
677 state (including a sim instance) that we allocate prior to
678 invoking push_target(). We want to delay the push_target()
679 operation until after we complete those operations which could
682 unpush_target (&gdbsim_ops);
684 len = (7 + 1 /* gdbsim */
685 + strlen (" -E little")
686 + strlen (" --architecture=xxxxxxxxxx")
687 + strlen (" --sysroot=") + strlen (gdb_sysroot) +
688 + (args ? strlen (args) : 0)
690 arg_buf = (char *) alloca (len);
691 strcpy (arg_buf, "gdbsim"); /* 7 */
692 /* Specify the byte order for the target when it is explicitly
693 specified by the user (not auto detected). */
694 switch (selected_byte_order ())
697 strcat (arg_buf, " -E big");
699 case BFD_ENDIAN_LITTLE:
700 strcat (arg_buf, " -E little");
702 case BFD_ENDIAN_UNKNOWN:
705 /* Specify the architecture of the target when it has been
706 explicitly specified */
707 if (selected_architecture_name () != NULL)
709 strcat (arg_buf, " --architecture=");
710 strcat (arg_buf, selected_architecture_name ());
712 /* Pass along gdb's concept of the sysroot. */
713 strcat (arg_buf, " --sysroot=");
714 strcat (arg_buf, gdb_sysroot);
715 /* finally, any explicit args */
718 strcat (arg_buf, " "); /* 1 */
719 strcat (arg_buf, args);
721 sim_argv = gdb_buildargv (arg_buf);
724 gdbsim_desc = sim_open (SIM_OPEN_DEBUG, &gdb_callback, exec_bfd, sim_argv);
726 if (gdbsim_desc == 0)
730 error (_("unable to create simulator instance"));
733 /* Reset the pid numberings for this batch of sim instances. */
734 next_pid = INITIAL_PID;
736 /* Allocate the inferior data, but do not allocate a sim instance
737 since we've already just done that. */
738 sim_data = get_sim_inferior_data (current_inferior (),
739 SIM_INSTANCE_NOT_NEEDED);
741 sim_data->gdbsim_desc = gdbsim_desc;
743 push_target (&gdbsim_ops);
744 printf_filtered ("Connected to the simulator.\n");
746 /* There's nothing running after "target sim" or "load"; not until
748 inferior_ptid = null_ptid;
753 /* Callback for iterate_over_inferiors. Called (indirectly) by
757 gdbsim_close_inferior (struct inferior *inf, void *arg)
759 struct sim_inferior_data *sim_data = inferior_data (inf,
760 sim_inferior_data_key);
761 if (sim_data != NULL)
763 ptid_t ptid = sim_data->remote_sim_ptid;
765 sim_inferior_data_cleanup (inf, sim_data);
766 set_inferior_data (inf, sim_inferior_data_key, NULL);
768 /* Having a ptid allocated and stored in remote_sim_ptid does
769 not mean that a corresponding inferior was ever created.
770 Thus we need to verify the existence of an inferior using the
771 pid in question before setting inferior_ptid via
772 switch_to_thread() or mourning the inferior. */
773 if (find_inferior_pid (ptid_get_pid (ptid)) != NULL)
775 switch_to_thread (ptid);
776 generic_mourn_inferior ();
783 /* Does whatever cleanup is required for a target that we are no longer
784 going to be calling. Argument says whether we are quitting gdb and
785 should not get hung in case of errors, or whether we want a clean
786 termination even if it takes a while. This routine is automatically
787 always called just before a routine is popped off the target stack.
788 Closing file descriptors and freeing memory are typical things it should
790 /* Close out all files and local state before this target loses control. */
793 gdbsim_close (int quitting)
795 struct sim_inferior_data *sim_data
796 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED);
799 printf_filtered ("gdbsim_close: quitting %d\n", quitting);
801 iterate_over_inferiors (gdbsim_close_inferior, NULL);
803 if (sim_argv != NULL)
814 /* Takes a program previously attached to and detaches it.
815 The program may resume execution (some targets do, some don't) and will
816 no longer stop on signals, etc. We better not have left any breakpoints
817 in the program or it'll die when it hits one. ARGS is arguments
818 typed by the user (e.g. a signal to send the process). FROM_TTY
819 says whether to be verbose or not. */
820 /* Terminate the open connection to the remote debugger.
821 Use this when you want to detach and do something else with your gdb. */
824 gdbsim_detach (struct target_ops *ops, char *args, int from_tty)
827 printf_filtered ("gdbsim_detach: args \"%s\"\n", args);
829 pop_target (); /* calls gdbsim_close to do the real work */
831 printf_filtered ("Ending simulator %s debugging\n", target_shortname);
834 /* Resume execution of the target process. STEP says whether to single-step
835 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
836 to the target, or zero for no signal. */
840 enum target_signal siggnal;
845 gdbsim_resume_inferior (struct inferior *inf, void *arg)
847 struct sim_inferior_data *sim_data
848 = get_sim_inferior_data (inf, SIM_INSTANCE_NOT_NEEDED);
849 struct resume_data *rd = arg;
853 sim_data->resume_siggnal = rd->siggnal;
854 sim_data->resume_step = rd->step;
857 printf_filtered (_("gdbsim_resume: pid %d, step %d, signal %d\n"),
858 inf->pid, rd->step, rd->siggnal);
861 /* When called from iterate_over_inferiors, a zero return causes the
862 iteration process to proceed until there are no more inferiors to
868 gdbsim_resume (struct target_ops *ops,
869 ptid_t ptid, int step, enum target_signal siggnal)
871 struct resume_data rd;
872 struct sim_inferior_data *sim_data
873 = get_sim_inferior_data_by_ptid (ptid, SIM_INSTANCE_NOT_NEEDED);
875 rd.siggnal = siggnal;
878 /* We don't access any sim_data members within this function.
879 What's of interest is whether or not the call to
880 get_sim_inferior_data_by_ptid(), above, is able to obtain a
881 non-NULL pointer. If it managed to obtain a non-NULL pointer, we
882 know we have a single inferior to consider. If it's NULL, we
883 either have multiple inferiors to resume or an error condition. */
886 gdbsim_resume_inferior (find_inferior_pid (ptid_get_pid (ptid)), &rd);
887 else if (ptid_equal (ptid, minus_one_ptid))
888 iterate_over_inferiors (gdbsim_resume_inferior, &rd);
890 error (_("The program is not being run."));
893 /* Notify the simulator of an asynchronous request to stop.
895 The simulator shall ensure that the stop request is eventually
896 delivered to the simulator. If the call is made while the
897 simulator is not running then the stop request is processed when
898 the simulator is next resumed.
900 For simulators that do not support this operation, just abort. */
903 gdbsim_stop_inferior (struct inferior *inf, void *arg)
905 struct sim_inferior_data *sim_data
906 = get_sim_inferior_data (inf, SIM_INSTANCE_NEEDED);
910 if (!sim_stop (sim_data->gdbsim_desc))
916 /* When called from iterate_over_inferiors, a zero return causes the
917 iteration process to proceed until there are no more inferiors to
923 gdbsim_stop (ptid_t ptid)
925 struct sim_inferior_data *sim_data;
927 if (ptid_equal (ptid, minus_one_ptid))
929 iterate_over_inferiors (gdbsim_stop_inferior, NULL);
933 struct inferior *inf = find_inferior_pid (ptid_get_pid (ptid));
936 error (_("Can't stop pid %d. No inferior found."),
937 ptid_get_pid (ptid));
939 gdbsim_stop_inferior (inf, NULL);
943 /* GDB version of os_poll_quit callback.
944 Taken from gdb/util.c - should be in a library. */
947 gdb_os_poll_quit (host_callback *p)
949 if (deprecated_ui_loop_hook != NULL)
950 deprecated_ui_loop_hook (0);
952 if (quit_flag) /* gdb's idea of quit */
954 quit_flag = 0; /* we've stolen it */
957 else if (immediate_quit)
964 /* Wait for inferior process to do something. Return pid of child,
965 or -1 in case of error; store status through argument pointer STATUS,
966 just as `wait' would. */
969 gdbsim_cntrl_c (int signo)
971 gdbsim_stop (minus_one_ptid);
975 gdbsim_wait (struct target_ops *ops,
976 ptid_t ptid, struct target_waitstatus *status, int options)
978 struct sim_inferior_data *sim_data;
979 static RETSIGTYPE (*prev_sigint) ();
981 enum sim_stop reason = sim_running;
983 /* This target isn't able to (yet) resume more than one inferior at a time.
984 When ptid is minus_one_ptid, just use the current inferior. If we're
985 given an explicit pid, we'll try to find it and use that instead. */
986 if (ptid_equal (ptid, minus_one_ptid))
987 sim_data = get_sim_inferior_data (current_inferior (),
988 SIM_INSTANCE_NEEDED);
991 sim_data = get_sim_inferior_data_by_ptid (ptid, SIM_INSTANCE_NEEDED);
992 if (sim_data == NULL)
993 error (_("Unable to wait for pid %d. Inferior not found."),
994 ptid_get_pid (ptid));
995 inferior_ptid = ptid;
999 printf_filtered ("gdbsim_wait\n");
1001 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1003 struct sigaction sa, osa;
1004 sa.sa_handler = gdbsim_cntrl_c;
1005 sigemptyset (&sa.sa_mask);
1007 sigaction (SIGINT, &sa, &osa);
1008 prev_sigint = osa.sa_handler;
1011 prev_sigint = signal (SIGINT, gdbsim_cntrl_c);
1013 sim_resume (sim_data->gdbsim_desc, sim_data->resume_step,
1014 sim_data->resume_siggnal);
1016 signal (SIGINT, prev_sigint);
1017 sim_data->resume_step = 0;
1019 sim_stop_reason (sim_data->gdbsim_desc, &reason, &sigrc);
1024 status->kind = TARGET_WAITKIND_EXITED;
1025 status->value.integer = sigrc;
1030 case TARGET_SIGNAL_ABRT:
1033 case TARGET_SIGNAL_INT:
1034 case TARGET_SIGNAL_TRAP:
1036 status->kind = TARGET_WAITKIND_STOPPED;
1037 status->value.sig = sigrc;
1042 status->kind = TARGET_WAITKIND_SIGNALLED;
1043 status->value.sig = sigrc;
1047 /* FIXME: Is this correct? */
1051 return inferior_ptid;
1054 /* Get ready to modify the registers array. On machines which store
1055 individual registers, this doesn't need to do anything. On machines
1056 which store all the registers in one fell swoop, this makes sure
1057 that registers contains all the registers from the program being
1061 gdbsim_prepare_to_store (struct regcache *regcache)
1063 /* Do nothing, since we can store individual regs. */
1066 /* Transfer LEN bytes between GDB address MYADDR and target address
1067 MEMADDR. If WRITE is non-zero, transfer them to the target,
1068 otherwise transfer them from the target. TARGET is unused.
1070 Returns the number of bytes transferred. */
1073 gdbsim_xfer_inferior_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len,
1074 int write, struct mem_attrib *attrib,
1075 struct target_ops *target)
1077 struct sim_inferior_data *sim_data
1078 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED);
1080 /* If this target doesn't have memory yet, return 0 causing the
1081 request to be passed to a lower target, hopefully an exec
1083 if (!target->to_has_memory (target))
1086 if (!sim_data->program_loaded)
1087 error (_("No program loaded."));
1089 /* Note that we obtained the sim_data pointer above using
1090 SIM_INSTANCE_NOT_NEEDED. We do this so that we don't needlessly
1091 allocate a sim instance prior to loading a program. If we
1092 get to this point in the code though, gdbsim_desc should be
1093 non-NULL. (Note that a sim instance is needed in order to load
1095 gdb_assert (sim_data->gdbsim_desc != NULL);
1099 /* FIXME: Send to something other than STDOUT? */
1100 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x");
1101 gdb_print_host_address (myaddr, gdb_stdout);
1102 printf_filtered (", memaddr %s, len %d, write %d\n",
1103 paddress (target_gdbarch, memaddr), len, write);
1104 if (remote_debug && write)
1105 dump_mem (myaddr, len);
1110 len = sim_write (sim_data->gdbsim_desc, memaddr, myaddr, len);
1114 len = sim_read (sim_data->gdbsim_desc, memaddr, myaddr, len);
1115 if (remote_debug && len > 0)
1116 dump_mem (myaddr, len);
1122 gdbsim_files_info (struct target_ops *target)
1124 struct sim_inferior_data *sim_data
1125 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NEEDED);
1126 const char *file = "nothing";
1129 file = bfd_get_filename (exec_bfd);
1132 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file);
1136 printf_filtered ("\tAttached to %s running program %s\n",
1137 target_shortname, file);
1138 sim_info (sim_data->gdbsim_desc, 0);
1142 /* Clear the simulator's notion of what the break points are. */
1145 gdbsim_mourn_inferior (struct target_ops *target)
1147 struct sim_inferior_data *sim_data
1148 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED);
1151 printf_filtered ("gdbsim_mourn_inferior:\n");
1153 remove_breakpoints ();
1154 generic_mourn_inferior ();
1155 delete_thread_silent (sim_data->remote_sim_ptid);
1158 /* Pass the command argument through to the simulator verbatim. The
1159 simulator must do any command interpretation work. */
1162 simulator_command (char *args, int from_tty)
1164 struct sim_inferior_data *sim_data;
1166 /* We use inferior_data() instead of get_sim_inferior_data() here in
1167 order to avoid attaching a sim_inferior_data struct to an
1168 inferior unnecessarily. The reason we take such care here is due
1169 to the fact that this function, simulator_command(), may be called
1170 even when the sim target is not active. If we were to use
1171 get_sim_inferior_data() here, it is possible that this call would
1172 be made either prior to gdbsim_open() or after gdbsim_close(),
1173 thus allocating memory that would not be garbage collected until
1174 the ultimate destruction of the associated inferior. */
1176 sim_data = inferior_data (current_inferior (), sim_inferior_data_key);
1177 if (sim_data == NULL || sim_data->gdbsim_desc == NULL)
1180 /* PREVIOUSLY: The user may give a command before the simulator
1181 is opened. [...] (??? assuming of course one wishes to
1182 continue to allow commands to be sent to unopened simulators,
1183 which isn't entirely unreasonable). */
1185 /* The simulator is a builtin abstraction of a remote target.
1186 Consistent with that model, access to the simulator, via sim
1187 commands, is restricted to the period when the channel to the
1188 simulator is open. */
1190 error (_("Not connected to the simulator target"));
1193 sim_do_command (sim_data->gdbsim_desc, args);
1195 /* Invalidate the register cache, in case the simulator command does
1197 registers_changed ();
1201 sim_command_completer (struct cmd_list_element *ignore, char *text, char *word)
1203 struct sim_inferior_data *sim_data;
1205 sim_data = inferior_data (current_inferior (), sim_inferior_data_key);
1206 if (sim_data == NULL || sim_data->gdbsim_desc == NULL)
1209 return sim_complete_command (sim_data->gdbsim_desc, text, word);
1212 /* Check to see if a thread is still alive. */
1215 gdbsim_thread_alive (struct target_ops *ops, ptid_t ptid)
1217 struct sim_inferior_data *sim_data
1218 = get_sim_inferior_data_by_ptid (ptid, SIM_INSTANCE_NOT_NEEDED);
1220 if (sim_data == NULL)
1223 if (ptid_equal (ptid, sim_data->remote_sim_ptid))
1224 /* The simulators' task is always alive. */
1230 /* Convert a thread ID to a string. Returns the string in a static
1234 gdbsim_pid_to_str (struct target_ops *ops, ptid_t ptid)
1236 return normal_pid_to_str (ptid);
1239 /* Simulator memory may be accessed after the program has been loaded. */
1242 gdbsim_has_all_memory (struct target_ops *ops)
1244 struct sim_inferior_data *sim_data
1245 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED);
1247 if (!sim_data->program_loaded)
1254 gdbsim_has_memory (struct target_ops *ops)
1256 struct sim_inferior_data *sim_data
1257 = get_sim_inferior_data (current_inferior (), SIM_INSTANCE_NOT_NEEDED);
1259 if (!sim_data->program_loaded)
1265 /* Define the target subroutine names. */
1267 struct target_ops gdbsim_ops;
1270 init_gdbsim_ops (void)
1272 gdbsim_ops.to_shortname = "sim";
1273 gdbsim_ops.to_longname = "simulator";
1274 gdbsim_ops.to_doc = "Use the compiled-in simulator.";
1275 gdbsim_ops.to_open = gdbsim_open;
1276 gdbsim_ops.to_close = gdbsim_close;
1277 gdbsim_ops.to_detach = gdbsim_detach;
1278 gdbsim_ops.to_resume = gdbsim_resume;
1279 gdbsim_ops.to_wait = gdbsim_wait;
1280 gdbsim_ops.to_fetch_registers = gdbsim_fetch_register;
1281 gdbsim_ops.to_store_registers = gdbsim_store_register;
1282 gdbsim_ops.to_prepare_to_store = gdbsim_prepare_to_store;
1283 gdbsim_ops.deprecated_xfer_memory = gdbsim_xfer_inferior_memory;
1284 gdbsim_ops.to_files_info = gdbsim_files_info;
1285 gdbsim_ops.to_insert_breakpoint = memory_insert_breakpoint;
1286 gdbsim_ops.to_remove_breakpoint = memory_remove_breakpoint;
1287 gdbsim_ops.to_kill = gdbsim_kill;
1288 gdbsim_ops.to_load = gdbsim_load;
1289 gdbsim_ops.to_create_inferior = gdbsim_create_inferior;
1290 gdbsim_ops.to_mourn_inferior = gdbsim_mourn_inferior;
1291 gdbsim_ops.to_stop = gdbsim_stop;
1292 gdbsim_ops.to_thread_alive = gdbsim_thread_alive;
1293 gdbsim_ops.to_pid_to_str = gdbsim_pid_to_str;
1294 gdbsim_ops.to_stratum = process_stratum;
1295 gdbsim_ops.to_has_all_memory = gdbsim_has_all_memory;
1296 gdbsim_ops.to_has_memory = gdbsim_has_memory;
1297 gdbsim_ops.to_has_stack = default_child_has_stack;
1298 gdbsim_ops.to_has_registers = default_child_has_registers;
1299 gdbsim_ops.to_has_execution = default_child_has_execution;
1300 gdbsim_ops.to_magic = OPS_MAGIC;
1304 _initialize_remote_sim (void)
1306 struct cmd_list_element *c;
1309 add_target (&gdbsim_ops);
1311 c = add_com ("sim", class_obscure, simulator_command,
1312 _("Send a command to the simulator."));
1313 set_cmd_completer (c, sim_command_completer);
1315 sim_inferior_data_key
1316 = register_inferior_data_with_cleanup (sim_inferior_data_cleanup);