1 /* Generic remote debugging interface for simulators.
3 Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 2002 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"
48 extern void _initialize_remote_sim (void);
50 extern int (*ui_loop_hook) (int signo);
52 static void dump_mem (char *buf, int len);
54 static void init_callbacks (void);
56 static void end_callbacks (void);
58 static int gdb_os_write_stdout (host_callback *, const char *, int);
60 static void gdb_os_flush_stdout (host_callback *);
62 static int gdb_os_write_stderr (host_callback *, const char *, int);
64 static void gdb_os_flush_stderr (host_callback *);
66 static int gdb_os_poll_quit (host_callback *);
68 /* printf_filtered is depreciated */
69 static void gdb_os_printf_filtered (host_callback *, const char *, ...);
71 static void gdb_os_vprintf_filtered (host_callback *, const char *, va_list);
73 static void gdb_os_evprintf_filtered (host_callback *, const char *, va_list);
75 static void gdb_os_error (host_callback *, const char *, ...);
77 static void gdbsim_fetch_register (int regno);
79 static void gdbsim_store_register (int regno);
81 static void gdbsim_kill (void);
83 static void gdbsim_load (char *prog, int fromtty);
85 static void gdbsim_create_inferior (char *exec_file, char *args, char **env);
87 static void gdbsim_open (char *args, int from_tty);
89 static void gdbsim_close (int quitting);
91 static void gdbsim_detach (char *args, int from_tty);
93 static void gdbsim_resume (ptid_t ptid, int step, enum target_signal siggnal);
95 static ptid_t gdbsim_wait (ptid_t ptid, struct target_waitstatus *status);
97 static void gdbsim_prepare_to_store (void);
99 static int gdbsim_xfer_inferior_memory (CORE_ADDR memaddr, char *myaddr,
101 struct mem_attrib *attrib,
102 struct target_ops *target);
104 static void gdbsim_files_info (struct target_ops *target);
106 static void gdbsim_mourn_inferior (void);
108 static void gdbsim_stop (void);
110 void simulator_command (char *args, int from_tty);
112 /* Naming convention:
114 sim_* are the interface to the simulator (see remote-sim.h).
115 gdbsim_* are stuff which is internal to gdb. */
117 /* Forward data declarations */
118 extern struct target_ops gdbsim_ops;
120 static int program_loaded = 0;
122 /* We must keep track of whether the simulator has been opened or not because
123 GDB can call a target's close routine twice, but sim_close doesn't allow
124 this. We also need to record the result of sim_open so we can pass it
125 back to the other sim_foo routines. */
126 static SIM_DESC gdbsim_desc = 0;
129 dump_mem (char *buf, int len)
133 if (len == 8 || len == 4)
136 memcpy (l, buf, len);
137 printf_filtered ("\t0x%lx", l[0]);
139 printf_filtered (" 0x%lx", l[1]);
140 printf_filtered ("\n");
145 printf_filtered ("\t");
146 for (i = 0; i < len; i++)
147 printf_filtered ("0x%x ", buf[i]);
148 printf_filtered ("\n");
153 static host_callback gdb_callback;
154 static int callbacks_initialized = 0;
156 /* Initialize gdb_callback. */
159 init_callbacks (void)
161 if (!callbacks_initialized)
163 gdb_callback = default_callback;
164 gdb_callback.init (&gdb_callback);
165 gdb_callback.write_stdout = gdb_os_write_stdout;
166 gdb_callback.flush_stdout = gdb_os_flush_stdout;
167 gdb_callback.write_stderr = gdb_os_write_stderr;
168 gdb_callback.flush_stderr = gdb_os_flush_stderr;
169 gdb_callback.printf_filtered = gdb_os_printf_filtered;
170 gdb_callback.vprintf_filtered = gdb_os_vprintf_filtered;
171 gdb_callback.evprintf_filtered = gdb_os_evprintf_filtered;
172 gdb_callback.error = gdb_os_error;
173 gdb_callback.poll_quit = gdb_os_poll_quit;
174 gdb_callback.magic = HOST_CALLBACK_MAGIC;
175 callbacks_initialized = 1;
179 /* Release callbacks (free resources used by them). */
184 if (callbacks_initialized)
186 gdb_callback.shutdown (&gdb_callback);
187 callbacks_initialized = 0;
191 /* GDB version of os_write_stdout callback. */
194 gdb_os_write_stdout (host_callback *p, const char *buf, int len)
199 ui_file_write (gdb_stdtarg, buf, len);
203 /* GDB version of os_flush_stdout callback. */
206 gdb_os_flush_stdout (host_callback *p)
208 gdb_flush (gdb_stdtarg);
211 /* GDB version of os_write_stderr callback. */
214 gdb_os_write_stderr (host_callback *p, const char *buf, int len)
219 for (i = 0; i < len; i++)
223 fputs_unfiltered (b, gdb_stdtarg);
228 /* GDB version of os_flush_stderr callback. */
231 gdb_os_flush_stderr (host_callback *p)
233 gdb_flush (gdb_stderr);
236 /* GDB version of printf_filtered callback. */
239 gdb_os_printf_filtered (host_callback * p, const char *format,...)
242 va_start (args, format);
244 vfprintf_filtered (gdb_stdout, format, args);
249 /* GDB version of error vprintf_filtered. */
252 gdb_os_vprintf_filtered (host_callback * p, const char *format, va_list ap)
254 vfprintf_filtered (gdb_stdout, format, ap);
257 /* GDB version of error evprintf_filtered. */
260 gdb_os_evprintf_filtered (host_callback * p, const char *format, va_list ap)
262 vfprintf_filtered (gdb_stderr, format, ap);
265 /* GDB version of error callback. */
268 gdb_os_error (host_callback * p, const char *format,...)
275 va_start (args, format);
276 verror (format, args);
282 one2one_register_sim_regno (int regnum)
284 /* Only makes sense to supply raw registers. */
285 gdb_assert (regnum >= 0 && regnum < NUM_REGS);
290 gdbsim_fetch_register (int regno)
294 for (regno = 0; regno < NUM_REGS; regno++)
295 gdbsim_fetch_register (regno);
299 switch (REGISTER_SIM_REGNO (regno))
301 case LEGACY_SIM_REGNO_IGNORE:
303 case SIM_REGNO_DOES_NOT_EXIST:
305 /* For moment treat a `does not exist' register the same way
306 as an ``unavailable'' register. */
307 char buf[MAX_REGISTER_SIZE];
309 memset (buf, 0, MAX_REGISTER_SIZE);
310 supply_register (regno, buf);
311 set_register_cached (regno, -1);
316 static int warn_user = 1;
317 char buf[MAX_REGISTER_SIZE];
319 gdb_assert (regno >= 0 && regno < NUM_REGS);
320 memset (buf, 0, MAX_REGISTER_SIZE);
321 nr_bytes = sim_fetch_register (gdbsim_desc,
322 REGISTER_SIM_REGNO (regno),
323 buf, REGISTER_RAW_SIZE (regno));
324 if (nr_bytes > 0 && nr_bytes != REGISTER_RAW_SIZE (regno) && warn_user)
326 fprintf_unfiltered (gdb_stderr,
327 "Size of register %s (%d/%d) incorrect (%d instead of %d))",
328 REGISTER_NAME (regno),
329 regno, REGISTER_SIM_REGNO (regno),
330 nr_bytes, REGISTER_RAW_SIZE (regno));
333 /* FIXME: cagney/2002-05-27: Should check `nr_bytes == 0'
334 indicatingthat GDB and the SIM have different ideas about
335 which registers are fetchable. */
336 /* Else if (nr_bytes < 0): an old simulator, that doesn't
337 think to return the register size. Just assume all is ok. */
338 supply_register (regno, buf);
341 printf_filtered ("gdbsim_fetch_register: %d", regno);
342 /* FIXME: We could print something more intelligible. */
343 dump_mem (buf, REGISTER_RAW_SIZE (regno));
352 gdbsim_store_register (int regno)
356 for (regno = 0; regno < NUM_REGS; regno++)
357 gdbsim_store_register (regno);
360 else if (REGISTER_SIM_REGNO (regno) >= 0)
362 char *tmp = alloca (max_register_size (current_gdbarch));
364 deprecated_read_register_gen (regno, tmp);
365 nr_bytes = sim_store_register (gdbsim_desc,
366 REGISTER_SIM_REGNO (regno),
367 tmp, REGISTER_RAW_SIZE (regno));
368 if (nr_bytes > 0 && nr_bytes != REGISTER_RAW_SIZE (regno))
369 internal_error (__FILE__, __LINE__,
370 "Register size different to expected");
371 /* FIXME: cagney/2002-05-27: Should check `nr_bytes == 0'
372 indicatingthat GDB and the SIM have different ideas about
373 which registers are fetchable. */
376 printf_filtered ("gdbsim_store_register: %d", regno);
377 /* FIXME: We could print something more intelligible. */
378 dump_mem (tmp, REGISTER_RAW_SIZE (regno));
383 /* Kill the running program. This may involve closing any open files
384 and releasing other resources acquired by the simulated program. */
390 printf_filtered ("gdbsim_kill\n");
392 /* There is no need to `kill' running simulator - the simulator is
394 inferior_ptid = null_ptid;
397 /* Load an executable file into the target process. This is expected to
398 not only bring new code into the target process, but also to update
399 GDB's symbol tables to match. */
402 gdbsim_load (char *prog, int fromtty)
405 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog);
407 inferior_ptid = null_ptid;
409 /* FIXME: We will print two messages on error.
410 Need error to either not print anything if passed NULL or need
411 another routine that doesn't take any arguments. */
412 if (sim_load (gdbsim_desc, prog, NULL, fromtty) == SIM_RC_FAIL)
413 error ("unable to load program");
415 /* FIXME: If a load command should reset the targets registers then
416 a call to sim_create_inferior() should go here. */
422 /* Start an inferior process and set inferior_ptid to its pid.
423 EXEC_FILE is the file to run.
424 ARGS is a string containing the arguments to the program.
425 ENV is the environment vector to pass. Errors reported with error().
426 On VxWorks and various standalone systems, we ignore exec_file. */
427 /* This is called not only when we first attach, but also when the
428 user types "run" after having attached. */
431 gdbsim_create_inferior (char *exec_file, char *args, char **env)
434 char *arg_buf, **argv;
436 if (exec_file == 0 || exec_bfd == 0)
437 warning ("No executable file specified.");
439 warning ("No program loaded.");
442 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
443 (exec_file ? exec_file : "(NULL)"),
447 remove_breakpoints ();
448 init_wait_for_inferior ();
450 if (exec_file != NULL)
452 len = strlen (exec_file) + 1 + strlen (args) + 1 + /*slop */ 10;
453 arg_buf = (char *) alloca (len);
455 strcat (arg_buf, exec_file);
456 strcat (arg_buf, " ");
457 strcat (arg_buf, args);
458 argv = buildargv (arg_buf);
459 make_cleanup_freeargv (argv);
463 sim_create_inferior (gdbsim_desc, exec_bfd, argv, env);
465 inferior_ptid = pid_to_ptid (42);
466 insert_breakpoints (); /* Needed to get correct instruction in cache */
468 clear_proceed_status ();
470 /* NB: Entry point already set by sim_create_inferior. */
471 proceed ((CORE_ADDR) -1, TARGET_SIGNAL_DEFAULT, 0);
474 /* The open routine takes the rest of the parameters from the command,
475 and (if successful) pushes a new target onto the stack.
476 Targets should supply this routine, if only to provide an error message. */
477 /* Called when selecting the simulator. EG: (gdb) target sim name. */
480 gdbsim_open (char *args, int from_tty)
487 printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
489 /* Remove current simulator if one exists. Only do this if the simulator
490 has been opened because sim_close requires it.
491 This is important because the call to push_target below will cause
492 sim_close to be called if the simulator is already open, but push_target
493 is called after sim_open! We can't move the call to push_target before
494 the call to sim_open because sim_open may invoke `error'. */
495 if (gdbsim_desc != NULL)
496 unpush_target (&gdbsim_ops);
498 len = (7 + 1 /* gdbsim */
499 + strlen (" -E little")
500 + strlen (" --architecture=xxxxxxxxxx")
501 + (args ? strlen (args) : 0)
503 arg_buf = (char *) alloca (len);
504 strcpy (arg_buf, "gdbsim"); /* 7 */
505 /* Specify the byte order for the target when it is both selectable
506 and explicitly specified by the user (not auto detected). */
507 if (!TARGET_BYTE_ORDER_AUTO)
509 switch (TARGET_BYTE_ORDER)
512 strcat (arg_buf, " -E big");
514 case BFD_ENDIAN_LITTLE:
515 strcat (arg_buf, " -E little");
518 internal_error (__FILE__, __LINE__,
519 "Value of TARGET_BYTE_ORDER unknown");
522 /* Specify the architecture of the target when it has been
523 explicitly specified */
524 if (!TARGET_ARCHITECTURE_AUTO)
526 strcat (arg_buf, " --architecture=");
527 strcat (arg_buf, TARGET_ARCHITECTURE->printable_name);
529 /* finally, any explicit args */
532 strcat (arg_buf, " "); /* 1 */
533 strcat (arg_buf, args);
535 argv = buildargv (arg_buf);
537 error ("Insufficient memory available to allocate simulator arg list.");
538 make_cleanup_freeargv (argv);
541 gdbsim_desc = sim_open (SIM_OPEN_DEBUG, &gdb_callback, exec_bfd, argv);
543 if (gdbsim_desc == 0)
544 error ("unable to create simulator instance");
546 push_target (&gdbsim_ops);
547 target_fetch_registers (-1);
548 printf_filtered ("Connected to the simulator.\n");
551 /* Does whatever cleanup is required for a target that we are no longer
552 going to be calling. Argument says whether we are quitting gdb and
553 should not get hung in case of errors, or whether we want a clean
554 termination even if it takes a while. This routine is automatically
555 always called just before a routine is popped off the target stack.
556 Closing file descriptors and freeing memory are typical things it should
558 /* Close out all files and local state before this target loses control. */
561 gdbsim_close (int quitting)
564 printf_filtered ("gdbsim_close: quitting %d\n", quitting);
568 if (gdbsim_desc != NULL)
570 sim_close (gdbsim_desc, quitting);
575 generic_mourn_inferior ();
578 /* Takes a program previously attached to and detaches it.
579 The program may resume execution (some targets do, some don't) and will
580 no longer stop on signals, etc. We better not have left any breakpoints
581 in the program or it'll die when it hits one. ARGS is arguments
582 typed by the user (e.g. a signal to send the process). FROM_TTY
583 says whether to be verbose or not. */
584 /* Terminate the open connection to the remote debugger.
585 Use this when you want to detach and do something else with your gdb. */
588 gdbsim_detach (char *args, int from_tty)
591 printf_filtered ("gdbsim_detach: args \"%s\"\n", args);
593 pop_target (); /* calls gdbsim_close to do the real work */
595 printf_filtered ("Ending simulator %s debugging\n", target_shortname);
598 /* Resume execution of the target process. STEP says whether to single-step
599 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
600 to the target, or zero for no signal. */
602 static enum target_signal resume_siggnal;
603 static int resume_step;
606 gdbsim_resume (ptid_t ptid, int step, enum target_signal siggnal)
608 if (PIDGET (inferior_ptid) != 42)
609 error ("The program is not being run.");
612 printf_filtered ("gdbsim_resume: step %d, signal %d\n", step, siggnal);
614 resume_siggnal = siggnal;
618 /* Notify the simulator of an asynchronous request to stop.
620 The simulator shall ensure that the stop request is eventually
621 delivered to the simulator. If the call is made while the
622 simulator is not running then the stop request is processed when
623 the simulator is next resumed.
625 For simulators that do not support this operation, just abort */
630 if (!sim_stop (gdbsim_desc))
636 /* GDB version of os_poll_quit callback.
637 Taken from gdb/util.c - should be in a library */
640 gdb_os_poll_quit (host_callback *p)
642 if (ui_loop_hook != NULL)
645 if (quit_flag) /* gdb's idea of quit */
647 quit_flag = 0; /* we've stolen it */
650 else if (immediate_quit)
657 /* Wait for inferior process to do something. Return pid of child,
658 or -1 in case of error; store status through argument pointer STATUS,
659 just as `wait' would. */
662 gdbsim_cntrl_c (int signo)
668 gdbsim_wait (ptid_t ptid, struct target_waitstatus *status)
670 static RETSIGTYPE (*prev_sigint) ();
672 enum sim_stop reason = sim_running;
675 printf_filtered ("gdbsim_wait\n");
677 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
679 struct sigaction sa, osa;
680 sa.sa_handler = gdbsim_cntrl_c;
681 sigemptyset (&sa.sa_mask);
683 sigaction (SIGINT, &sa, &osa);
684 prev_sigint = osa.sa_handler;
687 prev_sigint = signal (SIGINT, gdbsim_cntrl_c);
689 sim_resume (gdbsim_desc, resume_step,
690 target_signal_to_host (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;
711 status->kind = TARGET_WAITKIND_STOPPED;
712 /* The signal in sigrc is a host signal. That probably
714 status->value.sig = target_signal_from_host (sigrc);
719 status->kind = TARGET_WAITKIND_SIGNALLED;
720 /* The signal in sigrc is a host signal. That probably
722 status->value.sig = target_signal_from_host (sigrc);
726 /* FIXME: Is this correct? */
730 return inferior_ptid;
733 /* Get ready to modify the registers array. On machines which store
734 individual registers, this doesn't need to do anything. On machines
735 which store all the registers in one fell swoop, this makes sure
736 that registers contains all the registers from the program being
740 gdbsim_prepare_to_store (void)
742 /* Do nothing, since we can store individual regs */
745 /* Transfer LEN bytes between GDB address MYADDR and target address
746 MEMADDR. If WRITE is non-zero, transfer them to the target,
747 otherwise transfer them from the target. TARGET is unused.
749 Returns the number of bytes transferred. */
752 gdbsim_xfer_inferior_memory (CORE_ADDR memaddr, char *myaddr, int len,
753 int write, struct mem_attrib *attrib,
754 struct target_ops *target)
757 error ("No program loaded.");
761 /* FIXME: Send to something other than STDOUT? */
762 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x");
763 gdb_print_host_address (myaddr, gdb_stdout);
764 printf_filtered (", memaddr 0x%s, len %d, write %d\n",
765 paddr_nz (memaddr), len, write);
766 if (sr_get_debug () && write)
767 dump_mem (myaddr, len);
772 len = sim_write (gdbsim_desc, memaddr, myaddr, len);
776 len = sim_read (gdbsim_desc, memaddr, myaddr, len);
777 if (sr_get_debug () && len > 0)
778 dump_mem (myaddr, len);
784 gdbsim_files_info (struct target_ops *target)
786 char *file = "nothing";
789 file = bfd_get_filename (exec_bfd);
792 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file);
796 printf_filtered ("\tAttached to %s running program %s\n",
797 target_shortname, file);
798 sim_info (gdbsim_desc, 0);
802 /* Clear the simulator's notion of what the break points are. */
805 gdbsim_mourn_inferior (void)
808 printf_filtered ("gdbsim_mourn_inferior:\n");
810 remove_breakpoints ();
811 generic_mourn_inferior ();
815 gdbsim_insert_breakpoint (CORE_ADDR addr, char *contents_cache)
817 return memory_insert_breakpoint (addr, contents_cache);
821 gdbsim_remove_breakpoint (CORE_ADDR addr, char *contents_cache)
823 return memory_remove_breakpoint (addr, contents_cache);
826 /* Pass the command argument through to the simulator verbatim. The
827 simulator must do any command interpretation work. */
830 simulator_command (char *args, int from_tty)
832 if (gdbsim_desc == NULL)
835 /* PREVIOUSLY: The user may give a command before the simulator
836 is opened. [...] (??? assuming of course one wishes to
837 continue to allow commands to be sent to unopened simulators,
838 which isn't entirely unreasonable). */
840 /* The simulator is a builtin abstraction of a remote target.
841 Consistent with that model, access to the simulator, via sim
842 commands, is restricted to the period when the channel to the
843 simulator is open. */
845 error ("Not connected to the simulator target");
848 sim_do_command (gdbsim_desc, args);
850 /* Invalidate the register cache, in case the simulator command does
852 registers_changed ();
855 /* Define the target subroutine names */
857 struct target_ops gdbsim_ops;
860 init_gdbsim_ops (void)
862 gdbsim_ops.to_shortname = "sim";
863 gdbsim_ops.to_longname = "simulator";
864 gdbsim_ops.to_doc = "Use the compiled-in simulator.";
865 gdbsim_ops.to_open = gdbsim_open;
866 gdbsim_ops.to_close = gdbsim_close;
867 gdbsim_ops.to_detach = gdbsim_detach;
868 gdbsim_ops.to_resume = gdbsim_resume;
869 gdbsim_ops.to_wait = gdbsim_wait;
870 gdbsim_ops.to_fetch_registers = gdbsim_fetch_register;
871 gdbsim_ops.to_store_registers = gdbsim_store_register;
872 gdbsim_ops.to_prepare_to_store = gdbsim_prepare_to_store;
873 gdbsim_ops.to_xfer_memory = gdbsim_xfer_inferior_memory;
874 gdbsim_ops.to_files_info = gdbsim_files_info;
875 gdbsim_ops.to_insert_breakpoint = gdbsim_insert_breakpoint;
876 gdbsim_ops.to_remove_breakpoint = gdbsim_remove_breakpoint;
877 gdbsim_ops.to_kill = gdbsim_kill;
878 gdbsim_ops.to_load = gdbsim_load;
879 gdbsim_ops.to_create_inferior = gdbsim_create_inferior;
880 gdbsim_ops.to_mourn_inferior = gdbsim_mourn_inferior;
881 gdbsim_ops.to_stop = gdbsim_stop;
882 gdbsim_ops.to_stratum = process_stratum;
883 gdbsim_ops.to_has_all_memory = 1;
884 gdbsim_ops.to_has_memory = 1;
885 gdbsim_ops.to_has_stack = 1;
886 gdbsim_ops.to_has_registers = 1;
887 gdbsim_ops.to_has_execution = 1;
888 gdbsim_ops.to_magic = OPS_MAGIC;
890 #ifdef TARGET_REDEFINE_DEFAULT_OPS
891 TARGET_REDEFINE_DEFAULT_OPS (&gdbsim_ops);
896 _initialize_remote_sim (void)
899 add_target (&gdbsim_ops);
901 add_com ("sim <command>", class_obscure, simulator_command,
902 "Send a command to the simulator.");