1 /* Generic remote debugging interface for simulators.
3 Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 2002, 2004 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 int gdbsim_xfer_inferior_memory (CORE_ADDR memaddr, char *myaddr,
98 struct mem_attrib *attrib,
99 struct target_ops *target);
101 static void gdbsim_files_info (struct target_ops *target);
103 static void gdbsim_mourn_inferior (void);
105 static void gdbsim_stop (void);
107 void simulator_command (char *args, int from_tty);
109 /* Naming convention:
111 sim_* are the interface to the simulator (see remote-sim.h).
112 gdbsim_* are stuff which is internal to gdb. */
114 /* Forward data declarations */
115 extern struct target_ops gdbsim_ops;
117 static int program_loaded = 0;
119 /* We must keep track of whether the simulator has been opened or not because
120 GDB can call a target's close routine twice, but sim_close doesn't allow
121 this. We also need to record the result of sim_open so we can pass it
122 back to the other sim_foo routines. */
123 static SIM_DESC gdbsim_desc = 0;
126 dump_mem (char *buf, int len)
130 if (len == 8 || len == 4)
133 memcpy (l, buf, len);
134 printf_filtered ("\t0x%lx", l[0]);
136 printf_filtered (" 0x%lx", l[1]);
137 printf_filtered ("\n");
142 printf_filtered ("\t");
143 for (i = 0; i < len; i++)
144 printf_filtered ("0x%x ", buf[i]);
145 printf_filtered ("\n");
150 static host_callback gdb_callback;
151 static int callbacks_initialized = 0;
153 /* Initialize gdb_callback. */
156 init_callbacks (void)
158 if (!callbacks_initialized)
160 gdb_callback = default_callback;
161 gdb_callback.init (&gdb_callback);
162 gdb_callback.write_stdout = gdb_os_write_stdout;
163 gdb_callback.flush_stdout = gdb_os_flush_stdout;
164 gdb_callback.write_stderr = gdb_os_write_stderr;
165 gdb_callback.flush_stderr = gdb_os_flush_stderr;
166 gdb_callback.printf_filtered = gdb_os_printf_filtered;
167 gdb_callback.vprintf_filtered = gdb_os_vprintf_filtered;
168 gdb_callback.evprintf_filtered = gdb_os_evprintf_filtered;
169 gdb_callback.error = gdb_os_error;
170 gdb_callback.poll_quit = gdb_os_poll_quit;
171 gdb_callback.magic = HOST_CALLBACK_MAGIC;
172 callbacks_initialized = 1;
176 /* Release callbacks (free resources used by them). */
181 if (callbacks_initialized)
183 gdb_callback.shutdown (&gdb_callback);
184 callbacks_initialized = 0;
188 /* GDB version of os_write_stdout callback. */
191 gdb_os_write_stdout (host_callback *p, const char *buf, int len)
196 ui_file_write (gdb_stdtarg, buf, len);
200 /* GDB version of os_flush_stdout callback. */
203 gdb_os_flush_stdout (host_callback *p)
205 gdb_flush (gdb_stdtarg);
208 /* GDB version of os_write_stderr callback. */
211 gdb_os_write_stderr (host_callback *p, const char *buf, int len)
216 for (i = 0; i < len; i++)
220 fputs_unfiltered (b, gdb_stdtargerr);
225 /* GDB version of os_flush_stderr callback. */
228 gdb_os_flush_stderr (host_callback *p)
230 gdb_flush (gdb_stdtargerr);
233 /* GDB version of printf_filtered callback. */
236 gdb_os_printf_filtered (host_callback * p, const char *format,...)
239 va_start (args, format);
241 vfprintf_filtered (gdb_stdout, format, args);
246 /* GDB version of error vprintf_filtered. */
249 gdb_os_vprintf_filtered (host_callback * p, const char *format, va_list ap)
251 vfprintf_filtered (gdb_stdout, format, ap);
254 /* GDB version of error evprintf_filtered. */
257 gdb_os_evprintf_filtered (host_callback * p, const char *format, va_list ap)
259 vfprintf_filtered (gdb_stderr, format, ap);
262 /* GDB version of error callback. */
265 gdb_os_error (host_callback * p, const char *format,...)
267 if (deprecated_error_hook)
268 (*deprecated_error_hook) ();
272 va_start (args, format);
273 verror (format, args);
279 one2one_register_sim_regno (int regnum)
281 /* Only makes sense to supply raw registers. */
282 gdb_assert (regnum >= 0 && regnum < NUM_REGS);
287 gdbsim_fetch_register (int regno)
291 for (regno = 0; regno < NUM_REGS; regno++)
292 gdbsim_fetch_register (regno);
296 switch (REGISTER_SIM_REGNO (regno))
298 case LEGACY_SIM_REGNO_IGNORE:
300 case SIM_REGNO_DOES_NOT_EXIST:
302 /* For moment treat a `does not exist' register the same way
303 as an ``unavailable'' register. */
304 char buf[MAX_REGISTER_SIZE];
306 memset (buf, 0, MAX_REGISTER_SIZE);
307 regcache_raw_supply (current_regcache, regno, buf);
308 set_register_cached (regno, -1);
313 static int warn_user = 1;
314 char buf[MAX_REGISTER_SIZE];
316 gdb_assert (regno >= 0 && regno < NUM_REGS);
317 memset (buf, 0, MAX_REGISTER_SIZE);
318 nr_bytes = sim_fetch_register (gdbsim_desc,
319 REGISTER_SIM_REGNO (regno),
320 buf, DEPRECATED_REGISTER_RAW_SIZE (regno));
321 if (nr_bytes > 0 && nr_bytes != DEPRECATED_REGISTER_RAW_SIZE (regno) && warn_user)
323 fprintf_unfiltered (gdb_stderr,
324 "Size of register %s (%d/%d) incorrect (%d instead of %d))",
325 REGISTER_NAME (regno),
326 regno, REGISTER_SIM_REGNO (regno),
327 nr_bytes, DEPRECATED_REGISTER_RAW_SIZE (regno));
330 /* FIXME: cagney/2002-05-27: Should check `nr_bytes == 0'
331 indicating that GDB and the SIM have different ideas about
332 which registers are fetchable. */
333 /* Else if (nr_bytes < 0): an old simulator, that doesn't
334 think to return the register size. Just assume all is ok. */
335 regcache_raw_supply (current_regcache, regno, buf);
338 printf_filtered ("gdbsim_fetch_register: %d", regno);
339 /* FIXME: We could print something more intelligible. */
340 dump_mem (buf, DEPRECATED_REGISTER_RAW_SIZE (regno));
349 gdbsim_store_register (int regno)
353 for (regno = 0; regno < NUM_REGS; regno++)
354 gdbsim_store_register (regno);
357 else if (REGISTER_SIM_REGNO (regno) >= 0)
359 char tmp[MAX_REGISTER_SIZE];
361 deprecated_read_register_gen (regno, tmp);
362 nr_bytes = sim_store_register (gdbsim_desc,
363 REGISTER_SIM_REGNO (regno),
364 tmp, DEPRECATED_REGISTER_RAW_SIZE (regno));
365 if (nr_bytes > 0 && nr_bytes != DEPRECATED_REGISTER_RAW_SIZE (regno))
366 internal_error (__FILE__, __LINE__,
367 "Register size different to expected");
368 /* FIXME: cagney/2002-05-27: Should check `nr_bytes == 0'
369 indicating that GDB and the SIM have different ideas about
370 which registers are fetchable. */
373 printf_filtered ("gdbsim_store_register: %d", regno);
374 /* FIXME: We could print something more intelligible. */
375 dump_mem (tmp, DEPRECATED_REGISTER_RAW_SIZE (regno));
380 /* Kill the running program. This may involve closing any open files
381 and releasing other resources acquired by the simulated program. */
387 printf_filtered ("gdbsim_kill\n");
389 /* There is no need to `kill' running simulator - the simulator is
391 inferior_ptid = null_ptid;
394 /* Load an executable file into the target process. This is expected to
395 not only bring new code into the target process, but also to update
396 GDB's symbol tables to match. */
399 gdbsim_load (char *prog, int fromtty)
402 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog);
404 inferior_ptid = null_ptid;
406 /* FIXME: We will print two messages on error.
407 Need error to either not print anything if passed NULL or need
408 another routine that doesn't take any arguments. */
409 if (sim_load (gdbsim_desc, prog, NULL, fromtty) == SIM_RC_FAIL)
410 error ("unable to load program");
412 /* FIXME: If a load command should reset the targets registers then
413 a call to sim_create_inferior() should go here. */
419 /* Start an inferior process and set inferior_ptid to its pid.
420 EXEC_FILE is the file to run.
421 ARGS is a string containing the arguments to the program.
422 ENV is the environment vector to pass. Errors reported with error().
423 On VxWorks and various standalone systems, we ignore exec_file. */
424 /* This is called not only when we first attach, but also when the
425 user types "run" after having attached. */
428 gdbsim_create_inferior (char *exec_file, char *args, char **env, int from_tty)
431 char *arg_buf, **argv;
433 if (exec_file == 0 || exec_bfd == 0)
434 warning ("No executable file specified.");
436 warning ("No program loaded.");
439 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
440 (exec_file ? exec_file : "(NULL)"),
444 remove_breakpoints ();
445 init_wait_for_inferior ();
447 if (exec_file != NULL)
449 len = strlen (exec_file) + 1 + strlen (args) + 1 + /*slop */ 10;
450 arg_buf = (char *) alloca (len);
452 strcat (arg_buf, exec_file);
453 strcat (arg_buf, " ");
454 strcat (arg_buf, args);
455 argv = buildargv (arg_buf);
456 make_cleanup_freeargv (argv);
460 sim_create_inferior (gdbsim_desc, exec_bfd, argv, env);
462 inferior_ptid = pid_to_ptid (42);
463 insert_breakpoints (); /* Needed to get correct instruction in cache */
465 clear_proceed_status ();
467 /* NB: Entry point already set by sim_create_inferior. */
468 proceed ((CORE_ADDR) -1, TARGET_SIGNAL_DEFAULT, 0);
471 /* The open routine takes the rest of the parameters from the command,
472 and (if successful) pushes a new target onto the stack.
473 Targets should supply this routine, if only to provide an error message. */
474 /* Called when selecting the simulator. EG: (gdb) target sim name. */
477 gdbsim_open (char *args, int from_tty)
484 printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
486 /* Remove current simulator if one exists. Only do this if the simulator
487 has been opened because sim_close requires it.
488 This is important because the call to push_target below will cause
489 sim_close to be called if the simulator is already open, but push_target
490 is called after sim_open! We can't move the call to push_target before
491 the call to sim_open because sim_open may invoke `error'. */
492 if (gdbsim_desc != NULL)
493 unpush_target (&gdbsim_ops);
495 len = (7 + 1 /* gdbsim */
496 + strlen (" -E little")
497 + strlen (" --architecture=xxxxxxxxxx")
498 + (args ? strlen (args) : 0)
500 arg_buf = (char *) alloca (len);
501 strcpy (arg_buf, "gdbsim"); /* 7 */
502 /* Specify the byte order for the target when it is both selectable
503 and explicitly specified by the user (not auto detected). */
504 switch (selected_byte_order ())
507 strcat (arg_buf, " -E big");
509 case BFD_ENDIAN_LITTLE:
510 strcat (arg_buf, " -E little");
512 case BFD_ENDIAN_UNKNOWN:
515 /* Specify the architecture of the target when it has been
516 explicitly specified */
517 if (selected_architecture_name () != NULL)
519 strcat (arg_buf, " --architecture=");
520 strcat (arg_buf, selected_architecture_name ());
522 /* finally, any explicit args */
525 strcat (arg_buf, " "); /* 1 */
526 strcat (arg_buf, args);
528 argv = buildargv (arg_buf);
530 error ("Insufficient memory available to allocate simulator arg list.");
531 make_cleanup_freeargv (argv);
534 gdbsim_desc = sim_open (SIM_OPEN_DEBUG, &gdb_callback, exec_bfd, argv);
536 if (gdbsim_desc == 0)
537 error ("unable to create simulator instance");
539 push_target (&gdbsim_ops);
540 target_fetch_registers (-1);
541 printf_filtered ("Connected to the simulator.\n");
544 /* Does whatever cleanup is required for a target that we are no longer
545 going to be calling. Argument says whether we are quitting gdb and
546 should not get hung in case of errors, or whether we want a clean
547 termination even if it takes a while. This routine is automatically
548 always called just before a routine is popped off the target stack.
549 Closing file descriptors and freeing memory are typical things it should
551 /* Close out all files and local state before this target loses control. */
554 gdbsim_close (int quitting)
557 printf_filtered ("gdbsim_close: quitting %d\n", quitting);
561 if (gdbsim_desc != NULL)
563 sim_close (gdbsim_desc, quitting);
568 generic_mourn_inferior ();
571 /* Takes a program previously attached to and detaches it.
572 The program may resume execution (some targets do, some don't) and will
573 no longer stop on signals, etc. We better not have left any breakpoints
574 in the program or it'll die when it hits one. ARGS is arguments
575 typed by the user (e.g. a signal to send the process). FROM_TTY
576 says whether to be verbose or not. */
577 /* Terminate the open connection to the remote debugger.
578 Use this when you want to detach and do something else with your gdb. */
581 gdbsim_detach (char *args, int from_tty)
584 printf_filtered ("gdbsim_detach: args \"%s\"\n", args);
586 pop_target (); /* calls gdbsim_close to do the real work */
588 printf_filtered ("Ending simulator %s debugging\n", target_shortname);
591 /* Resume execution of the target process. STEP says whether to single-step
592 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
593 to the target, or zero for no signal. */
595 static enum target_signal resume_siggnal;
596 static int resume_step;
599 gdbsim_resume (ptid_t ptid, int step, enum target_signal siggnal)
601 if (PIDGET (inferior_ptid) != 42)
602 error ("The program is not being run.");
605 printf_filtered ("gdbsim_resume: step %d, signal %d\n", step, siggnal);
607 resume_siggnal = siggnal;
611 /* Notify the simulator of an asynchronous request to stop.
613 The simulator shall ensure that the stop request is eventually
614 delivered to the simulator. If the call is made while the
615 simulator is not running then the stop request is processed when
616 the simulator is next resumed.
618 For simulators that do not support this operation, just abort */
623 if (!sim_stop (gdbsim_desc))
629 /* GDB version of os_poll_quit callback.
630 Taken from gdb/util.c - should be in a library */
633 gdb_os_poll_quit (host_callback *p)
635 if (deprecated_ui_loop_hook != NULL)
636 deprecated_ui_loop_hook (0);
638 if (quit_flag) /* gdb's idea of quit */
640 quit_flag = 0; /* we've stolen it */
643 else if (immediate_quit)
650 /* Wait for inferior process to do something. Return pid of child,
651 or -1 in case of error; store status through argument pointer STATUS,
652 just as `wait' would. */
655 gdbsim_cntrl_c (int signo)
661 gdbsim_wait (ptid_t ptid, struct target_waitstatus *status)
663 static RETSIGTYPE (*prev_sigint) ();
665 enum sim_stop reason = sim_running;
668 printf_filtered ("gdbsim_wait\n");
670 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
672 struct sigaction sa, osa;
673 sa.sa_handler = gdbsim_cntrl_c;
674 sigemptyset (&sa.sa_mask);
676 sigaction (SIGINT, &sa, &osa);
677 prev_sigint = osa.sa_handler;
680 prev_sigint = signal (SIGINT, gdbsim_cntrl_c);
682 sim_resume (gdbsim_desc, resume_step,
683 target_signal_to_host (resume_siggnal));
684 signal (SIGINT, prev_sigint);
687 sim_stop_reason (gdbsim_desc, &reason, &sigrc);
692 status->kind = TARGET_WAITKIND_EXITED;
693 status->value.integer = sigrc;
704 status->kind = TARGET_WAITKIND_STOPPED;
705 /* The signal in sigrc is a host signal. That probably
707 status->value.sig = target_signal_from_host (sigrc);
712 status->kind = TARGET_WAITKIND_SIGNALLED;
713 /* The signal in sigrc is a host signal. That probably
715 status->value.sig = target_signal_from_host (sigrc);
719 /* FIXME: Is this correct? */
723 return inferior_ptid;
726 /* Get ready to modify the registers array. On machines which store
727 individual registers, this doesn't need to do anything. On machines
728 which store all the registers in one fell swoop, this makes sure
729 that registers contains all the registers from the program being
733 gdbsim_prepare_to_store (void)
735 /* Do nothing, since we can store individual regs */
738 /* Transfer LEN bytes between GDB address MYADDR and target address
739 MEMADDR. If WRITE is non-zero, transfer them to the target,
740 otherwise transfer them from the target. TARGET is unused.
742 Returns the number of bytes transferred. */
745 gdbsim_xfer_inferior_memory (CORE_ADDR memaddr, char *myaddr, int len,
746 int write, struct mem_attrib *attrib,
747 struct target_ops *target)
750 error ("No program loaded.");
754 /* FIXME: Send to something other than STDOUT? */
755 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x");
756 gdb_print_host_address (myaddr, gdb_stdout);
757 printf_filtered (", memaddr 0x%s, len %d, write %d\n",
758 paddr_nz (memaddr), len, write);
759 if (sr_get_debug () && write)
760 dump_mem (myaddr, len);
765 len = sim_write (gdbsim_desc, memaddr, myaddr, len);
769 len = sim_read (gdbsim_desc, memaddr, myaddr, len);
770 if (sr_get_debug () && len > 0)
771 dump_mem (myaddr, len);
777 gdbsim_files_info (struct target_ops *target)
779 char *file = "nothing";
782 file = bfd_get_filename (exec_bfd);
785 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file);
789 printf_filtered ("\tAttached to %s running program %s\n",
790 target_shortname, file);
791 sim_info (gdbsim_desc, 0);
795 /* Clear the simulator's notion of what the break points are. */
798 gdbsim_mourn_inferior (void)
801 printf_filtered ("gdbsim_mourn_inferior:\n");
803 remove_breakpoints ();
804 generic_mourn_inferior ();
808 gdbsim_insert_breakpoint (CORE_ADDR addr, char *contents_cache)
810 return memory_insert_breakpoint (addr, contents_cache);
814 gdbsim_remove_breakpoint (CORE_ADDR addr, char *contents_cache)
816 return memory_remove_breakpoint (addr, contents_cache);
819 /* Pass the command argument through to the simulator verbatim. The
820 simulator must do any command interpretation work. */
823 simulator_command (char *args, int from_tty)
825 if (gdbsim_desc == NULL)
828 /* PREVIOUSLY: The user may give a command before the simulator
829 is opened. [...] (??? assuming of course one wishes to
830 continue to allow commands to be sent to unopened simulators,
831 which isn't entirely unreasonable). */
833 /* The simulator is a builtin abstraction of a remote target.
834 Consistent with that model, access to the simulator, via sim
835 commands, is restricted to the period when the channel to the
836 simulator is open. */
838 error ("Not connected to the simulator target");
841 sim_do_command (gdbsim_desc, args);
843 /* Invalidate the register cache, in case the simulator command does
845 registers_changed ();
848 /* Define the target subroutine names */
850 struct target_ops gdbsim_ops;
853 init_gdbsim_ops (void)
855 gdbsim_ops.to_shortname = "sim";
856 gdbsim_ops.to_longname = "simulator";
857 gdbsim_ops.to_doc = "Use the compiled-in simulator.";
858 gdbsim_ops.to_open = gdbsim_open;
859 gdbsim_ops.to_close = gdbsim_close;
860 gdbsim_ops.to_detach = gdbsim_detach;
861 gdbsim_ops.to_resume = gdbsim_resume;
862 gdbsim_ops.to_wait = gdbsim_wait;
863 gdbsim_ops.to_fetch_registers = gdbsim_fetch_register;
864 gdbsim_ops.to_store_registers = gdbsim_store_register;
865 gdbsim_ops.to_prepare_to_store = gdbsim_prepare_to_store;
866 gdbsim_ops.to_xfer_memory = gdbsim_xfer_inferior_memory;
867 gdbsim_ops.to_files_info = gdbsim_files_info;
868 gdbsim_ops.to_insert_breakpoint = gdbsim_insert_breakpoint;
869 gdbsim_ops.to_remove_breakpoint = gdbsim_remove_breakpoint;
870 gdbsim_ops.to_kill = gdbsim_kill;
871 gdbsim_ops.to_load = gdbsim_load;
872 gdbsim_ops.to_create_inferior = gdbsim_create_inferior;
873 gdbsim_ops.to_mourn_inferior = gdbsim_mourn_inferior;
874 gdbsim_ops.to_stop = gdbsim_stop;
875 gdbsim_ops.to_stratum = process_stratum;
876 gdbsim_ops.to_has_all_memory = 1;
877 gdbsim_ops.to_has_memory = 1;
878 gdbsim_ops.to_has_stack = 1;
879 gdbsim_ops.to_has_registers = 1;
880 gdbsim_ops.to_has_execution = 1;
881 gdbsim_ops.to_magic = OPS_MAGIC;
883 #ifdef TARGET_REDEFINE_DEFAULT_OPS
884 TARGET_REDEFINE_DEFAULT_OPS (&gdbsim_ops);
889 _initialize_remote_sim (void)
892 add_target (&gdbsim_ops);
894 add_com ("sim <command>", class_obscure, simulator_command,
895 "Send a command to the simulator.");