1 /* Generic remote debugging interface for simulators.
3 Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 2002, 2004, 2005 Free Software Foundation, Inc.
6 Contributed by Cygnus Support.
7 Steve Chamberlain (sac@cygnus.com).
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., 59 Temple Place - Suite 330,
24 Boston, MA 02111-1307, USA. */
29 #include "gdb_string.h"
38 #include "gdb/callback.h"
39 #include "gdb/remote-sim.h"
40 #include "remote-utils.h"
43 #include "gdb_assert.h"
44 #include "sim-regno.h"
45 #include "arch-utils.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 (int regno);
78 static void gdbsim_store_register (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 (void);
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 < NUM_REGS);
282 gdbsim_fetch_register (int regno)
286 for (regno = 0; regno < NUM_REGS; regno++)
287 gdbsim_fetch_register (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 (current_regcache, regno, buf);
303 set_register_cached (regno, -1);
308 static int warn_user = 1;
309 char buf[MAX_REGISTER_SIZE];
311 gdb_assert (regno >= 0 && regno < NUM_REGS);
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 (current_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 (int regno)
348 for (regno = 0; regno < NUM_REGS; regno++)
349 gdbsim_store_register (regno);
352 else if (REGISTER_SIM_REGNO (regno) >= 0)
354 char tmp[MAX_REGISTER_SIZE];
356 deprecated_read_register_gen (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
386 inferior_ptid = null_ptid;
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 *prog, int fromtty)
397 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog);
399 inferior_ptid = null_ptid;
401 /* FIXME: We will print two messages on error.
402 Need error to either not print anything if passed NULL or need
403 another routine that doesn't take any arguments. */
404 if (sim_load (gdbsim_desc, prog, NULL, fromtty) == SIM_RC_FAIL)
405 error (_("unable to load program"));
407 /* FIXME: If a load command should reset the targets registers then
408 a call to sim_create_inferior() should go here. */
414 /* Start an inferior process and set inferior_ptid to its pid.
415 EXEC_FILE is the file to run.
416 ARGS is a string containing the arguments to the program.
417 ENV is the environment vector to pass. Errors reported with error().
418 On VxWorks and various standalone systems, we ignore exec_file. */
419 /* This is called not only when we first attach, but also when the
420 user types "run" after having attached. */
423 gdbsim_create_inferior (char *exec_file, char *args, char **env, int from_tty)
426 char *arg_buf, **argv;
428 if (exec_file == 0 || exec_bfd == 0)
429 warning (_("No executable file specified."));
431 warning (_("No program loaded."));
434 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
435 (exec_file ? exec_file : "(NULL)"),
439 remove_breakpoints ();
440 init_wait_for_inferior ();
442 if (exec_file != NULL)
444 len = strlen (exec_file) + 1 + strlen (args) + 1 + /*slop */ 10;
445 arg_buf = (char *) alloca (len);
447 strcat (arg_buf, exec_file);
448 strcat (arg_buf, " ");
449 strcat (arg_buf, args);
450 argv = buildargv (arg_buf);
451 make_cleanup_freeargv (argv);
455 sim_create_inferior (gdbsim_desc, exec_bfd, argv, env);
457 inferior_ptid = pid_to_ptid (42);
458 insert_breakpoints (); /* Needed to get correct instruction in cache */
460 clear_proceed_status ();
462 /* NB: Entry point already set by sim_create_inferior. */
463 proceed ((CORE_ADDR) -1, TARGET_SIGNAL_DEFAULT, 0);
466 /* The open routine takes the rest of the parameters from the command,
467 and (if successful) pushes a new target onto the stack.
468 Targets should supply this routine, if only to provide an error message. */
469 /* Called when selecting the simulator. EG: (gdb) target sim name. */
472 gdbsim_open (char *args, int from_tty)
479 printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
481 /* Remove current simulator if one exists. Only do this if the simulator
482 has been opened because sim_close requires it.
483 This is important because the call to push_target below will cause
484 sim_close to be called if the simulator is already open, but push_target
485 is called after sim_open! We can't move the call to push_target before
486 the call to sim_open because sim_open may invoke `error'. */
487 if (gdbsim_desc != NULL)
488 unpush_target (&gdbsim_ops);
490 len = (7 + 1 /* gdbsim */
491 + strlen (" -E little")
492 + strlen (" --architecture=xxxxxxxxxx")
493 + (args ? strlen (args) : 0)
495 arg_buf = (char *) alloca (len);
496 strcpy (arg_buf, "gdbsim"); /* 7 */
497 /* Specify the byte order for the target when it is both selectable
498 and explicitly specified by the user (not auto detected). */
499 switch (selected_byte_order ())
502 strcat (arg_buf, " -E big");
504 case BFD_ENDIAN_LITTLE:
505 strcat (arg_buf, " -E little");
507 case BFD_ENDIAN_UNKNOWN:
510 /* Specify the architecture of the target when it has been
511 explicitly specified */
512 if (selected_architecture_name () != NULL)
514 strcat (arg_buf, " --architecture=");
515 strcat (arg_buf, selected_architecture_name ());
517 /* finally, any explicit args */
520 strcat (arg_buf, " "); /* 1 */
521 strcat (arg_buf, args);
523 argv = buildargv (arg_buf);
525 error (_("Insufficient memory available to allocate simulator arg list."));
526 make_cleanup_freeargv (argv);
529 gdbsim_desc = sim_open (SIM_OPEN_DEBUG, &gdb_callback, exec_bfd, argv);
531 if (gdbsim_desc == 0)
532 error (_("unable to create simulator instance"));
534 push_target (&gdbsim_ops);
535 target_fetch_registers (-1);
536 printf_filtered ("Connected to the simulator.\n");
539 /* Does whatever cleanup is required for a target that we are no longer
540 going to be calling. Argument says whether we are quitting gdb and
541 should not get hung in case of errors, or whether we want a clean
542 termination even if it takes a while. This routine is automatically
543 always called just before a routine is popped off the target stack.
544 Closing file descriptors and freeing memory are typical things it should
546 /* Close out all files and local state before this target loses control. */
549 gdbsim_close (int quitting)
552 printf_filtered ("gdbsim_close: quitting %d\n", quitting);
556 if (gdbsim_desc != NULL)
558 sim_close (gdbsim_desc, quitting);
563 generic_mourn_inferior ();
566 /* Takes a program previously attached to and detaches it.
567 The program may resume execution (some targets do, some don't) and will
568 no longer stop on signals, etc. We better not have left any breakpoints
569 in the program or it'll die when it hits one. ARGS is arguments
570 typed by the user (e.g. a signal to send the process). FROM_TTY
571 says whether to be verbose or not. */
572 /* Terminate the open connection to the remote debugger.
573 Use this when you want to detach and do something else with your gdb. */
576 gdbsim_detach (char *args, int from_tty)
579 printf_filtered ("gdbsim_detach: args \"%s\"\n", args);
581 pop_target (); /* calls gdbsim_close to do the real work */
583 printf_filtered ("Ending simulator %s debugging\n", target_shortname);
586 /* Resume execution of the target process. STEP says whether to single-step
587 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
588 to the target, or zero for no signal. */
590 static enum target_signal resume_siggnal;
591 static int resume_step;
594 gdbsim_resume (ptid_t ptid, int step, enum target_signal siggnal)
596 if (PIDGET (inferior_ptid) != 42)
597 error (_("The program is not being run."));
600 printf_filtered ("gdbsim_resume: step %d, signal %d\n", step, siggnal);
602 resume_siggnal = siggnal;
606 /* Notify the simulator of an asynchronous request to stop.
608 The simulator shall ensure that the stop request is eventually
609 delivered to the simulator. If the call is made while the
610 simulator is not running then the stop request is processed when
611 the simulator is next resumed.
613 For simulators that do not support this operation, just abort */
618 if (!sim_stop (gdbsim_desc))
624 /* GDB version of os_poll_quit callback.
625 Taken from gdb/util.c - should be in a library. */
628 gdb_os_poll_quit (host_callback *p)
630 if (deprecated_ui_loop_hook != NULL)
631 deprecated_ui_loop_hook (0);
633 if (quit_flag) /* gdb's idea of quit */
635 quit_flag = 0; /* we've stolen it */
638 else if (immediate_quit)
645 /* Wait for inferior process to do something. Return pid of child,
646 or -1 in case of error; store status through argument pointer STATUS,
647 just as `wait' would. */
650 gdbsim_cntrl_c (int signo)
656 gdbsim_wait (ptid_t ptid, struct target_waitstatus *status)
658 static RETSIGTYPE (*prev_sigint) ();
660 enum sim_stop reason = sim_running;
663 printf_filtered ("gdbsim_wait\n");
665 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
667 struct sigaction sa, osa;
668 sa.sa_handler = gdbsim_cntrl_c;
669 sigemptyset (&sa.sa_mask);
671 sigaction (SIGINT, &sa, &osa);
672 prev_sigint = osa.sa_handler;
675 prev_sigint = signal (SIGINT, gdbsim_cntrl_c);
677 sim_resume (gdbsim_desc, resume_step,
678 target_signal_to_host (resume_siggnal));
679 signal (SIGINT, prev_sigint);
682 sim_stop_reason (gdbsim_desc, &reason, &sigrc);
687 status->kind = TARGET_WAITKIND_EXITED;
688 status->value.integer = sigrc;
699 status->kind = TARGET_WAITKIND_STOPPED;
700 /* The signal in sigrc is a host signal. That probably
702 status->value.sig = target_signal_from_host (sigrc);
707 status->kind = TARGET_WAITKIND_SIGNALLED;
708 /* The signal in sigrc is a host signal. That probably
710 status->value.sig = target_signal_from_host (sigrc);
714 /* FIXME: Is this correct? */
718 return inferior_ptid;
721 /* Get ready to modify the registers array. On machines which store
722 individual registers, this doesn't need to do anything. On machines
723 which store all the registers in one fell swoop, this makes sure
724 that registers contains all the registers from the program being
728 gdbsim_prepare_to_store (void)
730 /* Do nothing, since we can store individual regs */
733 /* Transfer LEN bytes between GDB address MYADDR and target address
734 MEMADDR. If WRITE is non-zero, transfer them to the target,
735 otherwise transfer them from the target. TARGET is unused.
737 Returns the number of bytes transferred. */
740 gdbsim_xfer_inferior_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len,
741 int write, struct mem_attrib *attrib,
742 struct target_ops *target)
745 error (_("No program loaded."));
749 /* FIXME: Send to something other than STDOUT? */
750 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x");
751 gdb_print_host_address (myaddr, gdb_stdout);
752 printf_filtered (", memaddr 0x%s, len %d, write %d\n",
753 paddr_nz (memaddr), len, write);
754 if (sr_get_debug () && write)
755 dump_mem (myaddr, len);
760 len = sim_write (gdbsim_desc, memaddr, myaddr, len);
764 len = sim_read (gdbsim_desc, memaddr, myaddr, len);
765 if (sr_get_debug () && len > 0)
766 dump_mem (myaddr, len);
772 gdbsim_files_info (struct target_ops *target)
774 char *file = "nothing";
777 file = bfd_get_filename (exec_bfd);
780 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file);
784 printf_filtered ("\tAttached to %s running program %s\n",
785 target_shortname, file);
786 sim_info (gdbsim_desc, 0);
790 /* Clear the simulator's notion of what the break points are. */
793 gdbsim_mourn_inferior (void)
796 printf_filtered ("gdbsim_mourn_inferior:\n");
798 remove_breakpoints ();
799 generic_mourn_inferior ();
803 gdbsim_insert_breakpoint (CORE_ADDR addr, bfd_byte *contents_cache)
805 return memory_insert_breakpoint (addr, contents_cache);
809 gdbsim_remove_breakpoint (CORE_ADDR addr, bfd_byte *contents_cache)
811 return memory_remove_breakpoint (addr, contents_cache);
814 /* Pass the command argument through to the simulator verbatim. The
815 simulator must do any command interpretation work. */
818 simulator_command (char *args, int from_tty)
820 if (gdbsim_desc == NULL)
823 /* PREVIOUSLY: The user may give a command before the simulator
824 is opened. [...] (??? assuming of course one wishes to
825 continue to allow commands to be sent to unopened simulators,
826 which isn't entirely unreasonable). */
828 /* The simulator is a builtin abstraction of a remote target.
829 Consistent with that model, access to the simulator, via sim
830 commands, is restricted to the period when the channel to the
831 simulator is open. */
833 error (_("Not connected to the simulator target"));
836 sim_do_command (gdbsim_desc, args);
838 /* Invalidate the register cache, in case the simulator command does
840 registers_changed ();
843 /* Define the target subroutine names */
845 struct target_ops gdbsim_ops;
848 init_gdbsim_ops (void)
850 gdbsim_ops.to_shortname = "sim";
851 gdbsim_ops.to_longname = "simulator";
852 gdbsim_ops.to_doc = "Use the compiled-in simulator.";
853 gdbsim_ops.to_open = gdbsim_open;
854 gdbsim_ops.to_close = gdbsim_close;
855 gdbsim_ops.to_detach = gdbsim_detach;
856 gdbsim_ops.to_resume = gdbsim_resume;
857 gdbsim_ops.to_wait = gdbsim_wait;
858 gdbsim_ops.to_fetch_registers = gdbsim_fetch_register;
859 gdbsim_ops.to_store_registers = gdbsim_store_register;
860 gdbsim_ops.to_prepare_to_store = gdbsim_prepare_to_store;
861 gdbsim_ops.deprecated_xfer_memory = gdbsim_xfer_inferior_memory;
862 gdbsim_ops.to_files_info = gdbsim_files_info;
863 gdbsim_ops.to_insert_breakpoint = gdbsim_insert_breakpoint;
864 gdbsim_ops.to_remove_breakpoint = gdbsim_remove_breakpoint;
865 gdbsim_ops.to_kill = gdbsim_kill;
866 gdbsim_ops.to_load = gdbsim_load;
867 gdbsim_ops.to_create_inferior = gdbsim_create_inferior;
868 gdbsim_ops.to_mourn_inferior = gdbsim_mourn_inferior;
869 gdbsim_ops.to_stop = gdbsim_stop;
870 gdbsim_ops.to_stratum = process_stratum;
871 gdbsim_ops.to_has_all_memory = 1;
872 gdbsim_ops.to_has_memory = 1;
873 gdbsim_ops.to_has_stack = 1;
874 gdbsim_ops.to_has_registers = 1;
875 gdbsim_ops.to_has_execution = 1;
876 gdbsim_ops.to_magic = OPS_MAGIC;
878 #ifdef TARGET_REDEFINE_DEFAULT_OPS
879 TARGET_REDEFINE_DEFAULT_OPS (&gdbsim_ops);
884 _initialize_remote_sim (void)
887 add_target (&gdbsim_ops);
889 add_com ("sim", class_obscure, simulator_command,
890 _("Send a command to the simulator."));