1 /* Generic remote debugging interface for simulators.
2 Copyright 1993, 1994, 1996, 1997 Free Software Foundation, Inc.
3 Contributed by Cygnus Support.
4 Steve Chamberlain (sac@cygnus.com).
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
26 #include "gdb_string.h"
36 #include "remote-sim.h"
37 #include "remote-utils.h"
42 static void dump_mem
PARAMS ((char *buf
, int len
));
44 static void init_callbacks
PARAMS ((void));
46 static void end_callbacks
PARAMS ((void));
48 static int gdb_os_write_stdout
PARAMS ((host_callback
*, const char *, int));
50 static void gdb_os_flush_stdout
PARAMS ((host_callback
*));
52 static int gdb_os_write_stderr
PARAMS ((host_callback
*, const char *, int));
54 static void gdb_os_flush_stderr
PARAMS ((host_callback
*));
56 static int gdb_os_poll_quit
PARAMS ((host_callback
*));
58 /* printf_filtered is depreciated */
59 static void gdb_os_printf_filtered
PARAMS ((host_callback
*, const char *, ...));
61 static void gdb_os_vprintf_filtered
PARAMS ((host_callback
*, const char *, va_list));
63 static void gdb_os_evprintf_filtered
PARAMS ((host_callback
*, const char *, va_list));
65 static void gdb_os_error
PARAMS ((host_callback
*, const char *, ...));
67 static void gdbsim_fetch_register
PARAMS ((int regno
));
69 static void gdbsim_store_register
PARAMS ((int regno
));
71 static void gdbsim_kill
PARAMS ((void));
73 static void gdbsim_load
PARAMS ((char *prog
, int fromtty
));
75 static void gdbsim_create_inferior
PARAMS ((char *exec_file
, char *args
, char **env
));
77 static void gdbsim_open
PARAMS ((char *args
, int from_tty
));
79 static void gdbsim_close
PARAMS ((int quitting
));
81 static void gdbsim_detach
PARAMS ((char *args
, int from_tty
));
83 static void gdbsim_resume
PARAMS ((int pid
, int step
, enum target_signal siggnal
));
85 static int gdbsim_wait
PARAMS ((int pid
, struct target_waitstatus
*status
));
87 static void gdbsim_prepare_to_store
PARAMS ((void));
89 static int gdbsim_xfer_inferior_memory
PARAMS ((CORE_ADDR memaddr
,
90 char *myaddr
, int len
,
92 struct target_ops
*target
));
94 static void gdbsim_files_info
PARAMS ((struct target_ops
*target
));
96 static void gdbsim_mourn_inferior
PARAMS ((void));
98 static void gdbsim_stop
PARAMS ((void));
100 static void simulator_command
PARAMS ((char *args
, int from_tty
));
102 /* Naming convention:
104 sim_* are the interface to the simulator (see remote-sim.h).
105 gdbsim_* are stuff which is internal to gdb. */
107 /* Forward data declarations */
108 extern struct target_ops gdbsim_ops
;
110 static int program_loaded
= 0;
112 /* We must keep track of whether the simulator has been opened or not because
113 GDB can call a target's close routine twice, but sim_close doesn't allow
114 this. We also need to record the result of sim_open so we can pass it
115 back to the other sim_foo routines. */
116 static SIM_DESC gdbsim_desc
= 0;
125 if (len
== 8 || len
== 4)
128 memcpy (l
, buf
, len
);
129 printf_filtered ("\t0x%x", l
[0]);
130 printf_filtered (len
== 8 ? " 0x%x\n" : "\n", l
[1]);
135 printf_filtered ("\t");
136 for (i
= 0; i
< len
; i
++)
137 printf_filtered ("0x%x ", buf
[i
]);
138 printf_filtered ("\n");
143 static host_callback gdb_callback
;
144 static int callbacks_initialized
= 0;
146 /* Initialize gdb_callback. */
151 if (! callbacks_initialized
)
153 gdb_callback
= default_callback
;
154 gdb_callback
.init (&gdb_callback
);
155 gdb_callback
.write_stdout
= gdb_os_write_stdout
;
156 gdb_callback
.flush_stdout
= gdb_os_flush_stdout
;
157 gdb_callback
.write_stderr
= gdb_os_write_stderr
;
158 gdb_callback
.flush_stderr
= gdb_os_flush_stderr
;
159 gdb_callback
.printf_filtered
= gdb_os_printf_filtered
;
160 gdb_callback
.vprintf_filtered
= gdb_os_vprintf_filtered
;
161 gdb_callback
.evprintf_filtered
= gdb_os_evprintf_filtered
;
162 gdb_callback
.error
= gdb_os_error
;
163 gdb_callback
.poll_quit
= gdb_os_poll_quit
;
164 gdb_callback
.magic
= HOST_CALLBACK_MAGIC
;
165 callbacks_initialized
= 1;
169 /* Release callbacks (free resources used by them). */
174 if (callbacks_initialized
)
176 gdb_callback
.shutdown (&gdb_callback
);
177 callbacks_initialized
= 0;
181 /* GDB version of os_write_stdout callback. */
184 gdb_os_write_stdout (p
, buf
, len
)
192 for (i
= 0; i
< len
; i
++)
196 if (target_output_hook
)
197 target_output_hook (b
);
199 fputs_filtered (b
, gdb_stdout
);
204 /* GDB version of os_flush_stdout callback. */
207 gdb_os_flush_stdout (p
)
210 gdb_flush (gdb_stdout
);
213 /* GDB version of os_write_stderr callback. */
216 gdb_os_write_stderr (p
, buf
, len
)
224 for (i
= 0; i
< len
; i
++)
228 if (target_output_hook
)
229 target_output_hook (b
);
231 fputs_filtered (b
, gdb_stderr
);
236 /* GDB version of os_flush_stderr callback. */
239 gdb_os_flush_stderr (p
)
242 gdb_flush (gdb_stderr
);
245 /* GDB version of printf_filtered callback. */
249 #ifdef ANSI_PROTOTYPES
250 gdb_os_printf_filtered (host_callback
*p
, const char *format
, ...)
252 gdb_os_printf_filtered (p
, va_alist
)
258 #ifdef ANSI_PROTOTYPES
259 va_start (args
, format
);
264 format
= va_arg (args
, char *);
267 vfprintf_filtered (gdb_stdout
, format
, args
);
272 /* GDB version of error vprintf_filtered. */
276 #ifdef ANSI_PROTOTYPES
277 gdb_os_vprintf_filtered (host_callback
*p
, const char *format
, va_list ap
)
279 gdb_os_vprintf_filtered (p
, format
, ap
)
285 vfprintf_filtered (gdb_stdout
, format
, ap
);
288 /* GDB version of error evprintf_filtered. */
292 #ifdef ANSI_PROTOTYPES
293 gdb_os_evprintf_filtered (host_callback
*p
, const char *format
, va_list ap
)
295 gdb_os_evprintf_filtered (p
, format
, ap
)
301 vfprintf_filtered (gdb_stderr
, format
, ap
);
304 /* GDB version of error callback. */
308 #ifdef ANSI_PROTOTYPES
309 gdb_os_error (host_callback
*p
, const char *format
, ...)
311 gdb_os_error (p
, va_alist
)
321 #ifdef ANSI_PROTOTYPES
322 va_start (args
, format
);
327 format
= va_arg (args
, char *);
331 vfprintf_filtered (gdb_stderr
, format
, args
);
332 fprintf_filtered (gdb_stderr
, "\n");
334 return_to_top_level (RETURN_ERROR
);
339 gdbsim_fetch_register (regno
)
342 static int warn_user
= 1;
345 for (regno
= 0; regno
< NUM_REGS
; regno
++)
346 gdbsim_fetch_register (regno
);
348 else if (reg_names
[regno
] != NULL
&& *reg_names
[regno
] != '\0')
350 char buf
[MAX_REGISTER_RAW_SIZE
];
351 int nr_bytes
= sim_fetch_register (gdbsim_desc
, regno
, buf
, REGISTER_RAW_SIZE (regno
));
353 /* register not applicable, supply zero's */
354 memset (buf
, 0, MAX_REGISTER_RAW_SIZE
);
355 else if (nr_bytes
> 0 && nr_bytes
!= REGISTER_RAW_SIZE (regno
)
358 printf_unfiltered ("Size of register %s (%d) incorrect (%d instead of %d))",
359 reg_names
[regno
], regno
,
360 nr_bytes
, REGISTER_RAW_SIZE (regno
));
363 supply_register (regno
, buf
);
366 printf_filtered ("gdbsim_fetch_register: %d", regno
);
367 /* FIXME: We could print something more intelligible. */
368 dump_mem (buf
, REGISTER_RAW_SIZE (regno
));
375 gdbsim_store_register (regno
)
380 for (regno
= 0; regno
< NUM_REGS
; regno
++)
381 gdbsim_store_register (regno
);
383 else if (reg_names
[regno
] != NULL
&& *reg_names
[regno
] != '\0')
385 char tmp
[MAX_REGISTER_RAW_SIZE
];
387 read_register_gen (regno
, tmp
);
388 nr_bytes
= sim_store_register (gdbsim_desc
, regno
, tmp
, REGISTER_RAW_SIZE (regno
));
389 if (nr_bytes
> 0 && nr_bytes
!= REGISTER_RAW_SIZE (regno
))
390 fatal ("Register size different to expected");
393 printf_filtered ("gdbsim_store_register: %d", regno
);
394 /* FIXME: We could print something more intelligible. */
395 dump_mem (tmp
, REGISTER_RAW_SIZE (regno
));
400 /* Kill the running program. This may involve closing any open files
401 and releasing other resources acquired by the simulated program. */
407 printf_filtered ("gdbsim_kill\n");
409 /* There is no need to `kill' running simulator - the simulator is
414 /* Load an executable file into the target process. This is expected to
415 not only bring new code into the target process, but also to update
416 GDB's symbol tables to match. */
419 gdbsim_load (prog
, fromtty
)
424 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog
);
428 /* FIXME: We will print two messages on error.
429 Need error to either not print anything if passed NULL or need
430 another routine that doesn't take any arguments. */
431 if (sim_load (gdbsim_desc
, prog
, NULL
, fromtty
) == SIM_RC_FAIL
)
432 error ("unable to load program");
434 /* FIXME: If a load command should reset the targets registers then
435 a call to sim_create_inferior() should go here. */
441 /* Start an inferior process and set inferior_pid to its pid.
442 EXEC_FILE is the file to run.
443 ARGS is a string containing the arguments to the program.
444 ENV is the environment vector to pass. Errors reported with error().
445 On VxWorks and various standalone systems, we ignore exec_file. */
446 /* This is called not only when we first attach, but also when the
447 user types "run" after having attached. */
450 gdbsim_create_inferior (exec_file
, args
, env
)
456 char *arg_buf
,**argv
;
458 if (exec_file
== 0 || exec_bfd
== 0)
459 warning ("No exec file specified.");
460 if (! program_loaded
)
461 warning ("No program loaded.");
464 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
465 (exec_file
? exec_file
: "(NULL)"),
469 remove_breakpoints ();
470 init_wait_for_inferior ();
472 if (exec_file
!= NULL
)
474 len
= strlen (exec_file
) + 1 + strlen (args
) + 1 + /*slop*/ 10;
475 arg_buf
= (char *) alloca (len
);
477 strcat (arg_buf
, exec_file
);
478 strcat (arg_buf
, " ");
479 strcat (arg_buf
, args
);
480 argv
= buildargv (arg_buf
);
481 make_cleanup (freeargv
, (char *) argv
);
485 sim_create_inferior (gdbsim_desc
, exec_bfd
, argv
, env
);
488 insert_breakpoints (); /* Needed to get correct instruction in cache */
490 clear_proceed_status ();
492 /* NB: Entry point already set by sim_create_inferior. */
493 proceed ((CORE_ADDR
)-1, TARGET_SIGNAL_DEFAULT
, 0);
496 /* The open routine takes the rest of the parameters from the command,
497 and (if successful) pushes a new target onto the stack.
498 Targets should supply this routine, if only to provide an error message. */
499 /* Called when selecting the simulator. EG: (gdb) target sim name. */
502 gdbsim_open (args
, from_tty
)
511 printf_filtered ("gdbsim_open: args \"%s\"\n", args
? args
: "(null)");
513 /* Remove current simulator if one exists. Only do this if the simulator
514 has been opened because sim_close requires it.
515 This is important because the call to push_target below will cause
516 sim_close to be called if the simulator is already open, but push_target
517 is called after sim_open! We can't move the call to push_target before
518 the call to sim_open because sim_open may invoke `error'. */
519 if (gdbsim_desc
!= NULL
)
520 unpush_target (&gdbsim_ops
);
522 len
= (7 + 1 /* gdbsim */
523 + strlen (" -E little")
524 + strlen (" --architecture=xxxxxxxxxx")
525 + (args
? strlen (args
) : 0)
527 arg_buf
= (char *) alloca (len
);
528 strcpy (arg_buf
, "gdbsim"); /* 7 */
529 /* Specify the byte order for the target when it is both selectable
530 and explicitly specified by the user (not auto detected). */
531 #ifdef TARGET_BYTE_ORDER_SELECTABLE
532 if (!target_byte_order_auto
)
534 switch (TARGET_BYTE_ORDER
)
537 strcat (arg_buf
, " -E big");
540 strcat (arg_buf
, " -E little");
543 fatal ("Value of TARGET_BYTE_ORDER unknown");
547 /* Specify the architecture of the target when it has been
548 explicitly specified */
549 if (!target_architecture_auto
)
551 strcat (arg_buf
, " --architecture=");
552 strcat (arg_buf
, target_architecture
->printable_name
);
554 /* finally, any explicit args */
557 strcat (arg_buf
, " "); /* 1 */
558 strcat (arg_buf
, args
);
560 argv
= buildargv (arg_buf
);
562 error ("Insufficient memory available to allocate simulator arg list.");
563 make_cleanup (freeargv
, (char *) argv
);
566 gdbsim_desc
= sim_open (SIM_OPEN_DEBUG
, &gdb_callback
, exec_bfd
, argv
);
568 if (gdbsim_desc
== 0)
569 error ("unable to create simulator instance");
571 push_target (&gdbsim_ops
);
572 target_fetch_registers (-1);
573 printf_filtered ("Connected to the simulator.\n");
576 /* Does whatever cleanup is required for a target that we are no longer
577 going to be calling. Argument says whether we are quitting gdb and
578 should not get hung in case of errors, or whether we want a clean
579 termination even if it takes a while. This routine is automatically
580 always called just before a routine is popped off the target stack.
581 Closing file descriptors and freeing memory are typical things it should
583 /* Close out all files and local state before this target loses control. */
586 gdbsim_close (quitting
)
590 printf_filtered ("gdbsim_close: quitting %d\n", quitting
);
594 if (gdbsim_desc
!= NULL
)
596 sim_close (gdbsim_desc
, quitting
);
603 /* Takes a program previously attached to and detaches it.
604 The program may resume execution (some targets do, some don't) and will
605 no longer stop on signals, etc. We better not have left any breakpoints
606 in the program or it'll die when it hits one. ARGS is arguments
607 typed by the user (e.g. a signal to send the process). FROM_TTY
608 says whether to be verbose or not. */
609 /* Terminate the open connection to the remote debugger.
610 Use this when you want to detach and do something else with your gdb. */
613 gdbsim_detach (args
,from_tty
)
618 printf_filtered ("gdbsim_detach: args \"%s\"\n", args
);
620 pop_target (); /* calls gdbsim_close to do the real work */
622 printf_filtered ("Ending simulator %s debugging\n", target_shortname
);
625 /* Resume execution of the target process. STEP says whether to single-step
626 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
627 to the target, or zero for no signal. */
629 static enum target_signal resume_siggnal
;
630 static int resume_step
;
633 gdbsim_resume (pid
, step
, siggnal
)
635 enum target_signal siggnal
;
637 if (inferior_pid
!= 42)
638 error ("The program is not being run.");
641 printf_filtered ("gdbsim_resume: step %d, signal %d\n", step
, siggnal
);
643 resume_siggnal
= siggnal
;
647 /* Notify the simulator of an asynchronous request to stop.
649 The simulator shall ensure that the stop request is eventually
650 delivered to the simulator. If the call is made while the
651 simulator is not running then the stop request is processed when
652 the simulator is next resumed.
654 For simulators that do not support this operation, just abort */
659 if (! sim_stop (gdbsim_desc
))
665 /* GDB version of os_poll_quit callback.
666 Taken from gdb/util.c - should be in a library */
673 if (quit_flag
) /* gdb's idea of quit */
675 quit_flag
= 0; /* we've stolen it */
678 else if (immediate_quit
)
685 /* Wait for inferior process to do something. Return pid of child,
686 or -1 in case of error; store status through argument pointer STATUS,
687 just as `wait' would. */
690 gdbsim_cntrl_c (signo
)
697 gdbsim_wait (pid
, status
)
699 struct target_waitstatus
*status
;
701 static RETSIGTYPE (*prev_sigint
) ();
703 enum sim_stop reason
= sim_running
;
706 printf_filtered ("gdbsim_wait\n");
708 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
710 struct sigaction sa
, osa
;
711 sa
.sa_handler
= gdbsim_cntrl_c
;
712 sigemptyset (&sa
.sa_mask
);
714 sigaction (SIGINT
, &sa
, &osa
);
715 prev_sigint
= osa
.sa_handler
;
718 prev_sigint
= signal (SIGINT
, gdbsim_cntrl_c
);
720 sim_resume (gdbsim_desc
, resume_step
,
721 target_signal_to_host (resume_siggnal
));
722 signal (SIGINT
, prev_sigint
);
725 sim_stop_reason (gdbsim_desc
, &reason
, &sigrc
);
730 status
->kind
= TARGET_WAITKIND_EXITED
;
731 status
->value
.integer
= sigrc
;
742 status
->kind
= TARGET_WAITKIND_STOPPED
;
743 /* The signal in sigrc is a host signal. That probably
745 status
->value
.sig
= target_signal_from_host (sigrc
);
750 status
->kind
= TARGET_WAITKIND_SIGNALLED
;
751 /* The signal in sigrc is a host signal. That probably
753 status
->value
.sig
= target_signal_from_host (sigrc
);
757 /* FIXME: Is this correct? */
764 /* Get ready to modify the registers array. On machines which store
765 individual registers, this doesn't need to do anything. On machines
766 which store all the registers in one fell swoop, this makes sure
767 that registers contains all the registers from the program being
771 gdbsim_prepare_to_store ()
773 /* Do nothing, since we can store individual regs */
777 gdbsim_xfer_inferior_memory (memaddr
, myaddr
, len
, write
, target
)
782 struct target_ops
*target
; /* ignored */
784 if (! program_loaded
)
785 error ("No program loaded.");
789 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x%x, memaddr 0x%x, len %d, write %d\n",
790 myaddr
, memaddr
, len
, write
);
791 if (sr_get_debug () && write
)
792 dump_mem(myaddr
, len
);
797 len
= sim_write (gdbsim_desc
, memaddr
, myaddr
, len
);
801 len
= sim_read (gdbsim_desc
, memaddr
, myaddr
, len
);
802 if (sr_get_debug () && len
> 0)
803 dump_mem(myaddr
, len
);
809 gdbsim_files_info (target
)
810 struct target_ops
*target
;
812 char *file
= "nothing";
815 file
= bfd_get_filename (exec_bfd
);
818 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file
);
822 printf_filtered ("\tAttached to %s running program %s\n",
823 target_shortname
, file
);
824 sim_info (gdbsim_desc
, 0);
828 /* Clear the simulator's notion of what the break points are. */
831 gdbsim_mourn_inferior ()
834 printf_filtered ("gdbsim_mourn_inferior:\n");
836 remove_breakpoints ();
837 generic_mourn_inferior ();
841 gdbsim_insert_breakpoint (addr
, contents_cache
)
843 char *contents_cache
;
845 #ifdef SIM_HAS_BREAKPOINTS
848 retcode
= sim_set_breakpoint (gdbsim_desc
, addr
);
854 case SIM_RC_INSUFFICIENT_RESOURCES
:
860 return memory_insert_breakpoint (addr
, contents_cache
);
865 gdbsim_remove_breakpoint (addr
, contents_cache
)
867 char *contents_cache
;
869 #ifdef SIM_HAS_BREAKPOINTS
872 retcode
= sim_clear_breakpoint (gdbsim_desc
, addr
);
877 case SIM_RC_UNKNOWN_BREAKPOINT
:
879 case SIM_RC_INSUFFICIENT_RESOURCES
:
885 return memory_remove_breakpoint (addr
, contents_cache
);
889 /* Pass the command argument through to the simulator verbatim. The
890 simulator must do any command interpretation work. */
893 simulator_command (args
, from_tty
)
897 if (gdbsim_desc
== NULL
)
900 /* PREVIOUSLY: The user may give a command before the simulator
901 is opened. [...] (??? assuming of course one wishes to
902 continue to allow commands to be sent to unopened simulators,
903 which isn't entirely unreasonable). */
905 /* The simulator is a builtin abstraction of a remote target.
906 Consistent with that model, access to the simulator, via sim
907 commands, is restricted to the period when the channel to the
908 simulator is open. */
910 error ("Not connected to the simulator target");
913 sim_do_command (gdbsim_desc
, args
);
916 /* Define the target subroutine names */
918 struct target_ops gdbsim_ops
= {
919 "sim", /* to_shortname */
920 "simulator", /* to_longname */
921 "Use the compiled-in simulator.", /* to_doc */
922 gdbsim_open
, /* to_open */
923 gdbsim_close
, /* to_close */
924 NULL
, /* to_attach */
925 gdbsim_detach
, /* to_detach */
926 gdbsim_resume
, /* to_resume */
927 gdbsim_wait
, /* to_wait */
928 gdbsim_fetch_register
, /* to_fetch_registers */
929 gdbsim_store_register
, /* to_store_registers */
930 gdbsim_prepare_to_store
, /* to_prepare_to_store */
931 gdbsim_xfer_inferior_memory
, /* to_xfer_memory */
932 gdbsim_files_info
, /* to_files_info */
933 gdbsim_insert_breakpoint
, /* to_insert_breakpoint */
934 gdbsim_remove_breakpoint
, /* to_remove_breakpoint */
935 NULL
, /* to_terminal_init */
936 NULL
, /* to_terminal_inferior */
937 NULL
, /* to_terminal_ours_for_output */
938 NULL
, /* to_terminal_ours */
939 NULL
, /* to_terminal_info */
940 gdbsim_kill
, /* to_kill */
941 gdbsim_load
, /* to_load */
942 NULL
, /* to_lookup_symbol */
943 gdbsim_create_inferior
, /* to_create_inferior */
944 gdbsim_mourn_inferior
, /* to_mourn_inferior */
946 0, /* to_notice_signals */
947 0, /* to_thread_alive */
948 gdbsim_stop
, /* to_stop */
949 process_stratum
, /* to_stratum */
951 1, /* to_has_all_memory */
952 1, /* to_has_memory */
953 1, /* to_has_stack */
954 1, /* to_has_registers */
955 1, /* to_has_execution */
957 NULL
, /* sections_end */
958 OPS_MAGIC
, /* to_magic */
962 _initialize_remote_sim ()
964 add_target (&gdbsim_ops
);
966 add_com ("sim <command>", class_obscure
, simulator_command
,
967 "Send a command to the simulator.");