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 Free Software Foundation, Inc.
6 Contributed by Cygnus Support.
9 This file is part of GDB.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 Boston, MA 02110-1301, USA. */
29 #include "gdb_string.h"
38 #include "gdb/callback.h"
39 #include "gdb/remote-sim.h"
42 #include "gdb_assert.h"
43 #include "sim-regno.h"
44 #include "arch-utils.h"
45 #include "readline/readline.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 *, ...);
76 static void gdbsim_fetch_register (struct regcache *regcache, int regno);
78 static void gdbsim_store_register (struct regcache *regcache, int regno);
80 static void gdbsim_kill (void);
82 static void gdbsim_load (char *prog, int fromtty);
84 static void gdbsim_open (char *args, int from_tty);
86 static void gdbsim_close (int quitting);
88 static void gdbsim_detach (char *args, int from_tty);
90 static void gdbsim_resume (ptid_t ptid, int step, enum target_signal siggnal);
92 static ptid_t gdbsim_wait (ptid_t ptid, struct target_waitstatus *status);
94 static void gdbsim_prepare_to_store (struct regcache *regcache);
96 static void gdbsim_files_info (struct target_ops *target);
98 static void gdbsim_mourn_inferior (void);
100 static void gdbsim_stop (void);
102 void simulator_command (char *args, int from_tty);
104 /* Naming convention:
106 sim_* are the interface to the simulator (see remote-sim.h).
107 gdbsim_* are stuff which is internal to gdb. */
109 /* Forward data declarations */
110 extern struct target_ops gdbsim_ops;
112 static int program_loaded = 0;
114 /* We must keep track of whether the simulator has been opened or not because
115 GDB can call a target's close routine twice, but sim_close doesn't allow
116 this. We also need to record the result of sim_open so we can pass it
117 back to the other sim_foo routines. */
118 static SIM_DESC gdbsim_desc = 0;
121 dump_mem (char *buf, int len)
125 if (len == 8 || len == 4)
128 memcpy (l, buf, len);
129 printf_filtered ("\t0x%lx", l[0]);
131 printf_filtered (" 0x%lx", l[1]);
132 printf_filtered ("\n");
137 printf_filtered ("\t");
138 for (i = 0; i < len; i++)
139 printf_filtered ("0x%x ", buf[i]);
140 printf_filtered ("\n");
145 static host_callback gdb_callback;
146 static int callbacks_initialized = 0;
148 /* Initialize gdb_callback. */
151 init_callbacks (void)
153 if (!callbacks_initialized)
155 gdb_callback = default_callback;
156 gdb_callback.init (&gdb_callback);
157 gdb_callback.write_stdout = gdb_os_write_stdout;
158 gdb_callback.flush_stdout = gdb_os_flush_stdout;
159 gdb_callback.write_stderr = gdb_os_write_stderr;
160 gdb_callback.flush_stderr = gdb_os_flush_stderr;
161 gdb_callback.printf_filtered = gdb_os_printf_filtered;
162 gdb_callback.vprintf_filtered = gdb_os_vprintf_filtered;
163 gdb_callback.evprintf_filtered = gdb_os_evprintf_filtered;
164 gdb_callback.error = gdb_os_error;
165 gdb_callback.poll_quit = gdb_os_poll_quit;
166 gdb_callback.magic = HOST_CALLBACK_MAGIC;
167 callbacks_initialized = 1;
171 /* Release callbacks (free resources used by them). */
176 if (callbacks_initialized)
178 gdb_callback.shutdown (&gdb_callback);
179 callbacks_initialized = 0;
183 /* GDB version of os_write_stdout callback. */
186 gdb_os_write_stdout (host_callback *p, const char *buf, int len)
191 ui_file_write (gdb_stdtarg, buf, len);
195 /* GDB version of os_flush_stdout callback. */
198 gdb_os_flush_stdout (host_callback *p)
200 gdb_flush (gdb_stdtarg);
203 /* GDB version of os_write_stderr callback. */
206 gdb_os_write_stderr (host_callback *p, const char *buf, int len)
211 for (i = 0; i < len; i++)
215 fputs_unfiltered (b, gdb_stdtargerr);
220 /* GDB version of os_flush_stderr callback. */
223 gdb_os_flush_stderr (host_callback *p)
225 gdb_flush (gdb_stdtargerr);
228 /* GDB version of printf_filtered callback. */
231 gdb_os_printf_filtered (host_callback * p, const char *format,...)
234 va_start (args, format);
236 vfprintf_filtered (gdb_stdout, format, args);
241 /* GDB version of error vprintf_filtered. */
244 gdb_os_vprintf_filtered (host_callback * p, const char *format, va_list ap)
246 vfprintf_filtered (gdb_stdout, format, ap);
249 /* GDB version of error evprintf_filtered. */
252 gdb_os_evprintf_filtered (host_callback * p, const char *format, va_list ap)
254 vfprintf_filtered (gdb_stderr, format, ap);
257 /* GDB version of error callback. */
260 gdb_os_error (host_callback * p, const char *format,...)
262 if (deprecated_error_hook)
263 (*deprecated_error_hook) ();
267 va_start (args, format);
268 verror (format, args);
274 one2one_register_sim_regno (int regnum)
276 /* Only makes sense to supply raw registers. */
277 gdb_assert (regnum >= 0 && regnum < gdbarch_num_regs (current_gdbarch));
282 gdbsim_fetch_register (struct regcache *regcache, int regno)
286 for (regno = 0; regno < gdbarch_num_regs (current_gdbarch); regno++)
287 gdbsim_fetch_register (regcache, regno);
291 switch (REGISTER_SIM_REGNO (regno))
293 case LEGACY_SIM_REGNO_IGNORE:
295 case SIM_REGNO_DOES_NOT_EXIST:
297 /* For moment treat a `does not exist' register the same way
298 as an ``unavailable'' register. */
299 char buf[MAX_REGISTER_SIZE];
301 memset (buf, 0, MAX_REGISTER_SIZE);
302 regcache_raw_supply (regcache, regno, buf);
308 static int warn_user = 1;
309 char buf[MAX_REGISTER_SIZE];
311 gdb_assert (regno >= 0 && regno < gdbarch_num_regs (current_gdbarch));
312 memset (buf, 0, MAX_REGISTER_SIZE);
313 nr_bytes = sim_fetch_register (gdbsim_desc,
314 REGISTER_SIM_REGNO (regno),
315 buf, register_size (current_gdbarch, regno));
316 if (nr_bytes > 0 && nr_bytes != register_size (current_gdbarch, regno) && warn_user)
318 fprintf_unfiltered (gdb_stderr,
319 "Size of register %s (%d/%d) incorrect (%d instead of %d))",
320 REGISTER_NAME (regno),
321 regno, REGISTER_SIM_REGNO (regno),
322 nr_bytes, register_size (current_gdbarch, regno));
325 /* FIXME: cagney/2002-05-27: Should check `nr_bytes == 0'
326 indicating that GDB and the SIM have different ideas about
327 which registers are fetchable. */
328 /* Else if (nr_bytes < 0): an old simulator, that doesn't
329 think to return the register size. Just assume all is ok. */
330 regcache_raw_supply (regcache, regno, buf);
333 printf_filtered ("gdbsim_fetch_register: %d", regno);
334 /* FIXME: We could print something more intelligible. */
335 dump_mem (buf, register_size (current_gdbarch, regno));
344 gdbsim_store_register (struct regcache *regcache, int regno)
348 for (regno = 0; regno < gdbarch_num_regs (current_gdbarch); regno++)
349 gdbsim_store_register (regcache, regno);
352 else if (REGISTER_SIM_REGNO (regno) >= 0)
354 char tmp[MAX_REGISTER_SIZE];
356 regcache_cooked_read (regcache, regno, tmp);
357 nr_bytes = sim_store_register (gdbsim_desc,
358 REGISTER_SIM_REGNO (regno),
359 tmp, register_size (current_gdbarch, regno));
360 if (nr_bytes > 0 && nr_bytes != register_size (current_gdbarch, regno))
361 internal_error (__FILE__, __LINE__,
362 _("Register size different to expected"));
363 /* FIXME: cagney/2002-05-27: Should check `nr_bytes == 0'
364 indicating that GDB and the SIM have different ideas about
365 which registers are fetchable. */
368 printf_filtered ("gdbsim_store_register: %d", regno);
369 /* FIXME: We could print something more intelligible. */
370 dump_mem (tmp, register_size (current_gdbarch, regno));
375 /* Kill the running program. This may involve closing any open files
376 and releasing other resources acquired by the simulated program. */
382 printf_filtered ("gdbsim_kill\n");
384 /* There is no need to `kill' running simulator - the simulator is
385 not running. Mourning it is enough. */
386 target_mourn_inferior ();
389 /* Load an executable file into the target process. This is expected to
390 not only bring new code into the target process, but also to update
391 GDB's symbol tables to match. */
394 gdbsim_load (char *args, int fromtty)
396 char **argv = buildargv (args);
402 make_cleanup_freeargv (argv);
404 prog = tilde_expand (argv[0]);
407 error (_("GDB sim does not yet support a load offset."));
410 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog);
412 /* FIXME: We will print two messages on error.
413 Need error to either not print anything if passed NULL or need
414 another routine that doesn't take any arguments. */
415 if (sim_load (gdbsim_desc, prog, NULL, fromtty) == SIM_RC_FAIL)
416 error (_("unable to load program"));
418 /* FIXME: If a load command should reset the targets registers then
419 a call to sim_create_inferior() should go here. */
425 /* Start an inferior process and set inferior_ptid to its pid.
426 EXEC_FILE is the file to run.
427 ARGS is a string containing the arguments to the program.
428 ENV is the environment vector to pass. Errors reported with error().
429 On VxWorks and various standalone systems, we ignore exec_file. */
430 /* This is called not only when we first attach, but also when the
431 user types "run" after having attached. */
434 gdbsim_create_inferior (char *exec_file, char *args, char **env, int from_tty)
437 char *arg_buf, **argv;
439 if (exec_file == 0 || exec_bfd == 0)
440 warning (_("No executable file specified."));
442 warning (_("No program loaded."));
445 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
446 (exec_file ? exec_file : "(NULL)"),
450 remove_breakpoints ();
451 init_wait_for_inferior ();
453 if (exec_file != NULL)
455 len = strlen (exec_file) + 1 + strlen (args) + 1 + /*slop */ 10;
456 arg_buf = (char *) alloca (len);
458 strcat (arg_buf, exec_file);
459 strcat (arg_buf, " ");
460 strcat (arg_buf, args);
461 argv = buildargv (arg_buf);
462 make_cleanup_freeargv (argv);
466 sim_create_inferior (gdbsim_desc, exec_bfd, argv, env);
468 inferior_ptid = pid_to_ptid (42);
469 target_mark_running (&gdbsim_ops);
470 insert_breakpoints (); /* Needed to get correct instruction in cache */
472 clear_proceed_status ();
475 /* The open routine takes the rest of the parameters from the command,
476 and (if successful) pushes a new target onto the stack.
477 Targets should supply this routine, if only to provide an error message. */
478 /* Called when selecting the simulator. EG: (gdb) target sim name. */
481 gdbsim_open (char *args, int from_tty)
488 printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
490 /* Remove current simulator if one exists. Only do this if the simulator
491 has been opened because sim_close requires it.
492 This is important because the call to push_target below will cause
493 sim_close to be called if the simulator is already open, but push_target
494 is called after sim_open! We can't move the call to push_target before
495 the call to sim_open because sim_open may invoke `error'. */
496 if (gdbsim_desc != NULL)
497 unpush_target (&gdbsim_ops);
499 len = (7 + 1 /* gdbsim */
500 + strlen (" -E little")
501 + strlen (" --architecture=xxxxxxxxxx")
502 + (args ? strlen (args) : 0)
504 arg_buf = (char *) alloca (len);
505 strcpy (arg_buf, "gdbsim"); /* 7 */
506 /* Specify the byte order for the target when it is explicitly
507 specified by the user (not auto detected). */
508 switch (selected_byte_order ())
511 strcat (arg_buf, " -E big");
513 case BFD_ENDIAN_LITTLE:
514 strcat (arg_buf, " -E little");
516 case BFD_ENDIAN_UNKNOWN:
519 /* Specify the architecture of the target when it has been
520 explicitly specified */
521 if (selected_architecture_name () != NULL)
523 strcat (arg_buf, " --architecture=");
524 strcat (arg_buf, selected_architecture_name ());
526 /* finally, any explicit args */
529 strcat (arg_buf, " "); /* 1 */
530 strcat (arg_buf, args);
532 argv = buildargv (arg_buf);
534 error (_("Insufficient memory available to allocate simulator arg list."));
535 make_cleanup_freeargv (argv);
538 gdbsim_desc = sim_open (SIM_OPEN_DEBUG, &gdb_callback, exec_bfd, argv);
540 if (gdbsim_desc == 0)
541 error (_("unable to create simulator instance"));
543 push_target (&gdbsim_ops);
544 printf_filtered ("Connected to the simulator.\n");
546 /* There's nothing running after "target sim" or "load"; not until
548 inferior_ptid = null_ptid;
549 target_mark_exited (&gdbsim_ops);
552 /* Does whatever cleanup is required for a target that we are no longer
553 going to be calling. Argument says whether we are quitting gdb and
554 should not get hung in case of errors, or whether we want a clean
555 termination even if it takes a while. This routine is automatically
556 always called just before a routine is popped off the target stack.
557 Closing file descriptors and freeing memory are typical things it should
559 /* Close out all files and local state before this target loses control. */
562 gdbsim_close (int quitting)
565 printf_filtered ("gdbsim_close: quitting %d\n", quitting);
569 if (gdbsim_desc != NULL)
571 sim_close (gdbsim_desc, quitting);
576 generic_mourn_inferior ();
579 /* Takes a program previously attached to and detaches it.
580 The program may resume execution (some targets do, some don't) and will
581 no longer stop on signals, etc. We better not have left any breakpoints
582 in the program or it'll die when it hits one. ARGS is arguments
583 typed by the user (e.g. a signal to send the process). FROM_TTY
584 says whether to be verbose or not. */
585 /* Terminate the open connection to the remote debugger.
586 Use this when you want to detach and do something else with your gdb. */
589 gdbsim_detach (char *args, int from_tty)
592 printf_filtered ("gdbsim_detach: args \"%s\"\n", args);
594 pop_target (); /* calls gdbsim_close to do the real work */
596 printf_filtered ("Ending simulator %s debugging\n", target_shortname);
599 /* Resume execution of the target process. STEP says whether to single-step
600 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
601 to the target, or zero for no signal. */
603 static enum target_signal resume_siggnal;
604 static int resume_step;
607 gdbsim_resume (ptid_t ptid, int step, enum target_signal siggnal)
609 if (PIDGET (inferior_ptid) != 42)
610 error (_("The program is not being run."));
613 printf_filtered ("gdbsim_resume: step %d, signal %d\n", step, siggnal);
615 resume_siggnal = siggnal;
619 /* Notify the simulator of an asynchronous request to stop.
621 The simulator shall ensure that the stop request is eventually
622 delivered to the simulator. If the call is made while the
623 simulator is not running then the stop request is processed when
624 the simulator is next resumed.
626 For simulators that do not support this operation, just abort */
631 if (!sim_stop (gdbsim_desc))
637 /* GDB version of os_poll_quit callback.
638 Taken from gdb/util.c - should be in a library. */
641 gdb_os_poll_quit (host_callback *p)
643 if (deprecated_ui_loop_hook != NULL)
644 deprecated_ui_loop_hook (0);
646 if (quit_flag) /* gdb's idea of quit */
648 quit_flag = 0; /* we've stolen it */
651 else if (immediate_quit)
658 /* Wait for inferior process to do something. Return pid of child,
659 or -1 in case of error; store status through argument pointer STATUS,
660 just as `wait' would. */
663 gdbsim_cntrl_c (int signo)
669 gdbsim_wait (ptid_t ptid, struct target_waitstatus *status)
671 static RETSIGTYPE (*prev_sigint) ();
673 enum sim_stop reason = sim_running;
676 printf_filtered ("gdbsim_wait\n");
678 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
680 struct sigaction sa, osa;
681 sa.sa_handler = gdbsim_cntrl_c;
682 sigemptyset (&sa.sa_mask);
684 sigaction (SIGINT, &sa, &osa);
685 prev_sigint = osa.sa_handler;
688 prev_sigint = signal (SIGINT, gdbsim_cntrl_c);
690 sim_resume (gdbsim_desc, resume_step, resume_siggnal);
691 signal (SIGINT, prev_sigint);
694 sim_stop_reason (gdbsim_desc, &reason, &sigrc);
699 status->kind = TARGET_WAITKIND_EXITED;
700 status->value.integer = sigrc;
705 case TARGET_SIGNAL_ABRT:
708 case TARGET_SIGNAL_INT:
709 case TARGET_SIGNAL_TRAP:
711 status->kind = TARGET_WAITKIND_STOPPED;
712 status->value.sig = sigrc;
717 status->kind = TARGET_WAITKIND_SIGNALLED;
718 status->value.sig = sigrc;
722 /* FIXME: Is this correct? */
726 return inferior_ptid;
729 /* Get ready to modify the registers array. On machines which store
730 individual registers, this doesn't need to do anything. On machines
731 which store all the registers in one fell swoop, this makes sure
732 that registers contains all the registers from the program being
736 gdbsim_prepare_to_store (struct regcache *regcache)
738 /* Do nothing, since we can store individual regs */
741 /* Transfer LEN bytes between GDB address MYADDR and target address
742 MEMADDR. If WRITE is non-zero, transfer them to the target,
743 otherwise transfer them from the target. TARGET is unused.
745 Returns the number of bytes transferred. */
748 gdbsim_xfer_inferior_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len,
749 int write, struct mem_attrib *attrib,
750 struct target_ops *target)
752 /* If no program is running yet, then ignore the simulator for
753 memory. Pass the request down to the next target, hopefully
755 if (!target_has_execution)
759 error (_("No program loaded."));
763 /* FIXME: Send to something other than STDOUT? */
764 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x");
765 gdb_print_host_address (myaddr, gdb_stdout);
766 printf_filtered (", memaddr 0x%s, len %d, write %d\n",
767 paddr_nz (memaddr), len, write);
768 if (remote_debug && write)
769 dump_mem (myaddr, len);
774 len = sim_write (gdbsim_desc, memaddr, myaddr, len);
778 len = sim_read (gdbsim_desc, memaddr, myaddr, len);
779 if (remote_debug && len > 0)
780 dump_mem (myaddr, len);
786 gdbsim_files_info (struct target_ops *target)
788 char *file = "nothing";
791 file = bfd_get_filename (exec_bfd);
794 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file);
798 printf_filtered ("\tAttached to %s running program %s\n",
799 target_shortname, file);
800 sim_info (gdbsim_desc, 0);
804 /* Clear the simulator's notion of what the break points are. */
807 gdbsim_mourn_inferior (void)
810 printf_filtered ("gdbsim_mourn_inferior:\n");
812 remove_breakpoints ();
813 target_mark_exited (&gdbsim_ops);
814 generic_mourn_inferior ();
817 /* Pass the command argument through to the simulator verbatim. The
818 simulator must do any command interpretation work. */
821 simulator_command (char *args, int from_tty)
823 if (gdbsim_desc == NULL)
826 /* PREVIOUSLY: The user may give a command before the simulator
827 is opened. [...] (??? assuming of course one wishes to
828 continue to allow commands to be sent to unopened simulators,
829 which isn't entirely unreasonable). */
831 /* The simulator is a builtin abstraction of a remote target.
832 Consistent with that model, access to the simulator, via sim
833 commands, is restricted to the period when the channel to the
834 simulator is open. */
836 error (_("Not connected to the simulator target"));
839 sim_do_command (gdbsim_desc, args);
841 /* Invalidate the register cache, in case the simulator command does
843 registers_changed ();
846 /* Define the target subroutine names */
848 struct target_ops gdbsim_ops;
851 init_gdbsim_ops (void)
853 gdbsim_ops.to_shortname = "sim";
854 gdbsim_ops.to_longname = "simulator";
855 gdbsim_ops.to_doc = "Use the compiled-in simulator.";
856 gdbsim_ops.to_open = gdbsim_open;
857 gdbsim_ops.to_close = gdbsim_close;
858 gdbsim_ops.to_detach = gdbsim_detach;
859 gdbsim_ops.to_resume = gdbsim_resume;
860 gdbsim_ops.to_wait = gdbsim_wait;
861 gdbsim_ops.to_fetch_registers = gdbsim_fetch_register;
862 gdbsim_ops.to_store_registers = gdbsim_store_register;
863 gdbsim_ops.to_prepare_to_store = gdbsim_prepare_to_store;
864 gdbsim_ops.deprecated_xfer_memory = gdbsim_xfer_inferior_memory;
865 gdbsim_ops.to_files_info = gdbsim_files_info;
866 gdbsim_ops.to_insert_breakpoint = memory_insert_breakpoint;
867 gdbsim_ops.to_remove_breakpoint = memory_remove_breakpoint;
868 gdbsim_ops.to_kill = gdbsim_kill;
869 gdbsim_ops.to_load = gdbsim_load;
870 gdbsim_ops.to_create_inferior = gdbsim_create_inferior;
871 gdbsim_ops.to_mourn_inferior = gdbsim_mourn_inferior;
872 gdbsim_ops.to_stop = gdbsim_stop;
873 gdbsim_ops.to_stratum = process_stratum;
874 gdbsim_ops.to_has_all_memory = 1;
875 gdbsim_ops.to_has_memory = 1;
876 gdbsim_ops.to_has_stack = 1;
877 gdbsim_ops.to_has_registers = 1;
878 gdbsim_ops.to_has_execution = 1;
879 gdbsim_ops.to_magic = OPS_MAGIC;
881 #ifdef TARGET_REDEFINE_DEFAULT_OPS
882 TARGET_REDEFINE_DEFAULT_OPS (&gdbsim_ops);
887 _initialize_remote_sim (void)
890 add_target (&gdbsim_ops);
892 add_com ("sim", class_obscure, simulator_command,
893 _("Send a command to the simulator."));