1 /* Generic remote debugging interface for simulators.
2 Copyright 1993, 1994, 1996, 1997 Free Software Foundation, Inc.
3 Contributed by Cygnus Support.
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)
344 for (regno = 0; regno < NUM_REGS; regno++)
345 gdbsim_fetch_register (regno);
347 else if (reg_names[regno] != NULL && *reg_names[regno] != '\0')
349 char buf[MAX_REGISTER_RAW_SIZE];
350 int nr_bytes = sim_fetch_register (gdbsim_desc, regno, buf, REGISTER_RAW_SIZE (regno));
352 /* register not applicable, supply zero's */
353 memset (buf, 0, MAX_REGISTER_RAW_SIZE);
354 else if (nr_bytes > 0 && nr_bytes != REGISTER_RAW_SIZE (regno))
355 fatal ("Register size different to expected");
356 supply_register (regno, buf);
359 printf_filtered ("gdbsim_fetch_register: %d", regno);
360 /* FIXME: We could print something more intelligible. */
361 dump_mem (buf, REGISTER_RAW_SIZE (regno));
368 gdbsim_store_register (regno)
373 for (regno = 0; regno < NUM_REGS; regno++)
374 gdbsim_store_register (regno);
376 else if (reg_names[regno] != NULL && *reg_names[regno] != '\0')
378 char tmp[MAX_REGISTER_RAW_SIZE];
380 read_register_gen (regno, tmp);
381 nr_bytes = sim_store_register (gdbsim_desc, regno, tmp, REGISTER_RAW_SIZE (regno));
382 if (nr_bytes > 0 && nr_bytes != REGISTER_RAW_SIZE (regno))
383 fatal ("Register size different to expected");
386 printf_filtered ("gdbsim_store_register: %d", regno);
387 /* FIXME: We could print something more intelligible. */
388 dump_mem (tmp, REGISTER_RAW_SIZE (regno));
393 /* Kill the running program. This may involve closing any open files
394 and releasing other resources acquired by the simulated program. */
400 printf_filtered ("gdbsim_kill\n");
402 /* There is no need to `kill' running simulator - the simulator is
407 /* Load an executable file into the target process. This is expected to
408 not only bring new code into the target process, but also to update
409 GDB's symbol tables to match. */
412 gdbsim_load (prog, fromtty)
417 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog);
421 /* FIXME: We will print two messages on error.
422 Need error to either not print anything if passed NULL or need
423 another routine that doesn't take any arguments. */
424 if (sim_load (gdbsim_desc, prog, NULL, fromtty) == SIM_RC_FAIL)
425 error ("unable to load program");
427 /* FIXME: If a load command should reset the targets registers then
428 a call to sim_create_inferior() should go here. */
434 /* Start an inferior process and set inferior_pid to its pid.
435 EXEC_FILE is the file to run.
436 ARGS is a string containing the arguments to the program.
437 ENV is the environment vector to pass. Errors reported with error().
438 On VxWorks and various standalone systems, we ignore exec_file. */
439 /* This is called not only when we first attach, but also when the
440 user types "run" after having attached. */
443 gdbsim_create_inferior (exec_file, args, env)
449 char *arg_buf,**argv;
451 if (exec_file == 0 || exec_bfd == 0)
452 warning ("No exec file specified.");
453 if (! program_loaded)
454 warning ("No program loaded.");
457 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
458 (exec_file ? exec_file: "(NULL)"),
462 remove_breakpoints ();
463 init_wait_for_inferior ();
465 if (exec_file != NULL)
467 len = strlen (exec_file) + 1 + strlen (args) + 1 + /*slop*/ 10;
468 arg_buf = (char *) alloca (len);
470 strcat (arg_buf, exec_file);
471 strcat (arg_buf, " ");
472 strcat (arg_buf, args);
473 argv = buildargv (arg_buf);
474 make_cleanup (freeargv, (char *) argv);
478 sim_create_inferior (gdbsim_desc, exec_bfd, argv, env);
481 insert_breakpoints (); /* Needed to get correct instruction in cache */
483 clear_proceed_status ();
485 /* NB: Entry point already set by sim_create_inferior. */
486 proceed ((CORE_ADDR)-1, TARGET_SIGNAL_DEFAULT, 0);
489 /* The open routine takes the rest of the parameters from the command,
490 and (if successful) pushes a new target onto the stack.
491 Targets should supply this routine, if only to provide an error message. */
492 /* Called when selecting the simulator. EG: (gdb) target sim name. */
495 gdbsim_open (args, from_tty)
504 printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
506 /* Remove current simulator if one exists. Only do this if the simulator
507 has been opened because sim_close requires it.
508 This is important because the call to push_target below will cause
509 sim_close to be called if the simulator is already open, but push_target
510 is called after sim_open! We can't move the call to push_target before
511 the call to sim_open because sim_open may invoke `error'. */
512 if (gdbsim_desc != NULL)
513 unpush_target (&gdbsim_ops);
515 len = (7 + 1 /* gdbsim */
516 + strlen (" -E little")
517 + strlen (" --architecture=xxxxxxxxxx")
518 + (args ? strlen (args) : 0)
520 arg_buf = (char *) alloca (len);
521 strcpy (arg_buf, "gdbsim"); /* 7 */
522 /* Specify the byte order for the target when it is both selectable
523 and explicitly specified by the user (not auto detected). */
524 #ifdef TARGET_BYTE_ORDER_SELECTABLE
525 if (!target_byte_order_auto)
527 switch (TARGET_BYTE_ORDER)
530 strcat (arg_buf, " -E big");
533 strcat (arg_buf, " -E little");
536 fatal ("Value of TARGET_BYTE_ORDER unknown");
540 /* Specify the architecture of the target when it has been
541 explicitly specified */
542 if (!target_architecture_auto)
544 strcat (arg_buf, " --architecture=");
545 strcat (arg_buf, target_architecture->printable_name);
547 /* finally, any explicit args */
550 strcat (arg_buf, " "); /* 1 */
551 strcat (arg_buf, args);
553 argv = buildargv (arg_buf);
555 error ("Insufficient memory available to allocate simulator arg list.");
556 make_cleanup (freeargv, (char *) argv);
559 gdbsim_desc = sim_open (SIM_OPEN_DEBUG, &gdb_callback, exec_bfd, argv);
561 if (gdbsim_desc == 0)
562 error ("unable to create simulator instance");
564 push_target (&gdbsim_ops);
565 target_fetch_registers (-1);
566 printf_filtered ("Connected to the simulator.\n");
569 /* Does whatever cleanup is required for a target that we are no longer
570 going to be calling. Argument says whether we are quitting gdb and
571 should not get hung in case of errors, or whether we want a clean
572 termination even if it takes a while. This routine is automatically
573 always called just before a routine is popped off the target stack.
574 Closing file descriptors and freeing memory are typical things it should
576 /* Close out all files and local state before this target loses control. */
579 gdbsim_close (quitting)
583 printf_filtered ("gdbsim_close: quitting %d\n", quitting);
587 if (gdbsim_desc != NULL)
589 sim_close (gdbsim_desc, quitting);
596 /* Takes a program previously attached to and detaches it.
597 The program may resume execution (some targets do, some don't) and will
598 no longer stop on signals, etc. We better not have left any breakpoints
599 in the program or it'll die when it hits one. ARGS is arguments
600 typed by the user (e.g. a signal to send the process). FROM_TTY
601 says whether to be verbose or not. */
602 /* Terminate the open connection to the remote debugger.
603 Use this when you want to detach and do something else with your gdb. */
606 gdbsim_detach (args,from_tty)
611 printf_filtered ("gdbsim_detach: args \"%s\"\n", args);
613 pop_target (); /* calls gdbsim_close to do the real work */
615 printf_filtered ("Ending simulator %s debugging\n", target_shortname);
618 /* Resume execution of the target process. STEP says whether to single-step
619 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
620 to the target, or zero for no signal. */
622 static enum target_signal resume_siggnal;
623 static int resume_step;
626 gdbsim_resume (pid, step, siggnal)
628 enum target_signal siggnal;
630 if (inferior_pid != 42)
631 error ("The program is not being run.");
634 printf_filtered ("gdbsim_resume: step %d, signal %d\n", step, siggnal);
636 resume_siggnal = siggnal;
640 /* Notify the simulator of an asynchronous request to stop.
642 The simulator shall ensure that the stop request is eventually
643 delivered to the simulator. If the call is made while the
644 simulator is not running then the stop request is processed when
645 the simulator is next resumed.
647 For simulators that do not support this operation, just abort */
652 if (! sim_stop (gdbsim_desc))
658 /* GDB version of os_poll_quit callback.
659 Taken from gdb/util.c - should be in a library */
666 if (quit_flag) /* gdb's idea of quit */
668 quit_flag = 0; /* we've stolen it */
671 else if (immediate_quit)
678 /* Wait for inferior process to do something. Return pid of child,
679 or -1 in case of error; store status through argument pointer STATUS,
680 just as `wait' would. */
683 gdbsim_cntrl_c (signo)
690 gdbsim_wait (pid, status)
692 struct target_waitstatus *status;
694 static RETSIGTYPE (*prev_sigint) ();
696 enum sim_stop reason = sim_running;
699 printf_filtered ("gdbsim_wait\n");
701 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
703 struct sigaction sa, osa;
704 sa.sa_handler = gdbsim_cntrl_c;
705 sigemptyset (&sa.sa_mask);
707 sigaction (SIGINT, &sa, &osa);
708 prev_sigint = osa.sa_handler;
711 prev_sigint = signal (SIGINT, gdbsim_cntrl_c);
713 sim_resume (gdbsim_desc, resume_step,
714 target_signal_to_host (resume_siggnal));
715 signal (SIGINT, prev_sigint);
718 sim_stop_reason (gdbsim_desc, &reason, &sigrc);
723 status->kind = TARGET_WAITKIND_EXITED;
724 status->value.integer = sigrc;
735 status->kind = TARGET_WAITKIND_STOPPED;
736 /* The signal in sigrc is a host signal. That probably
738 status->value.sig = target_signal_from_host (sigrc);
743 status->kind = TARGET_WAITKIND_SIGNALLED;
744 /* The signal in sigrc is a host signal. That probably
746 status->value.sig = target_signal_from_host (sigrc);
750 /* FIXME: Is this correct? */
757 /* Get ready to modify the registers array. On machines which store
758 individual registers, this doesn't need to do anything. On machines
759 which store all the registers in one fell swoop, this makes sure
760 that registers contains all the registers from the program being
764 gdbsim_prepare_to_store ()
766 /* Do nothing, since we can store individual regs */
770 gdbsim_xfer_inferior_memory (memaddr, myaddr, len, write, target)
775 struct target_ops *target; /* ignored */
777 if (! program_loaded)
778 error ("No program loaded.");
782 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x%x, memaddr 0x%x, len %d, write %d\n",
783 myaddr, memaddr, len, write);
784 if (sr_get_debug () && write)
785 dump_mem(myaddr, len);
790 len = sim_write (gdbsim_desc, memaddr, myaddr, len);
794 len = sim_read (gdbsim_desc, memaddr, myaddr, len);
795 if (sr_get_debug () && len > 0)
796 dump_mem(myaddr, len);
802 gdbsim_files_info (target)
803 struct target_ops *target;
805 char *file = "nothing";
808 file = bfd_get_filename (exec_bfd);
811 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file);
815 printf_filtered ("\tAttached to %s running program %s\n",
816 target_shortname, file);
817 sim_info (gdbsim_desc, 0);
821 /* Clear the simulator's notion of what the break points are. */
824 gdbsim_mourn_inferior ()
827 printf_filtered ("gdbsim_mourn_inferior:\n");
829 remove_breakpoints ();
830 generic_mourn_inferior ();
834 gdbsim_insert_breakpoint (addr, contents_cache)
836 char *contents_cache;
838 #ifdef SIM_HAS_BREAKPOINTS
841 retcode = sim_set_breakpoint (gdbsim_desc, addr);
847 case SIM_RC_INSUFFICIENT_RESOURCES:
853 return memory_insert_breakpoint (addr, contents_cache);
858 gdbsim_remove_breakpoint (addr, contents_cache)
860 char *contents_cache;
862 #ifdef SIM_HAS_BREAKPOINTS
865 retcode = sim_clear_breakpoint (gdbsim_desc, addr);
870 case SIM_RC_UNKNOWN_BREAKPOINT:
872 case SIM_RC_INSUFFICIENT_RESOURCES:
878 return memory_remove_breakpoint (addr, contents_cache);
882 /* Pass the command argument through to the simulator verbatim. The
883 simulator must do any command interpretation work. */
886 simulator_command (args, from_tty)
890 if (gdbsim_desc == NULL)
893 /* PREVIOUSLY: The user may give a command before the simulator
894 is opened. [...] (??? assuming of course one wishes to
895 continue to allow commands to be sent to unopened simulators,
896 which isn't entirely unreasonable). */
898 /* The simulator is a builtin abstraction of a remote target.
899 Consistent with that model, access to the simulator, via sim
900 commands, is restricted to the period when the channel to the
901 simulator is open. */
903 error ("Not connected to the simulator target");
906 sim_do_command (gdbsim_desc, args);
909 /* Define the target subroutine names */
911 struct target_ops gdbsim_ops = {
912 "sim", /* to_shortname */
913 "simulator", /* to_longname */
914 "Use the compiled-in simulator.", /* to_doc */
915 gdbsim_open, /* to_open */
916 gdbsim_close, /* to_close */
917 NULL, /* to_attach */
918 gdbsim_detach, /* to_detach */
919 gdbsim_resume, /* to_resume */
920 gdbsim_wait, /* to_wait */
921 gdbsim_fetch_register, /* to_fetch_registers */
922 gdbsim_store_register, /* to_store_registers */
923 gdbsim_prepare_to_store, /* to_prepare_to_store */
924 gdbsim_xfer_inferior_memory, /* to_xfer_memory */
925 gdbsim_files_info, /* to_files_info */
926 gdbsim_insert_breakpoint, /* to_insert_breakpoint */
927 gdbsim_remove_breakpoint, /* to_remove_breakpoint */
928 NULL, /* to_terminal_init */
929 NULL, /* to_terminal_inferior */
930 NULL, /* to_terminal_ours_for_output */
931 NULL, /* to_terminal_ours */
932 NULL, /* to_terminal_info */
933 gdbsim_kill, /* to_kill */
934 gdbsim_load, /* to_load */
935 NULL, /* to_lookup_symbol */
936 gdbsim_create_inferior, /* to_create_inferior */
937 gdbsim_mourn_inferior, /* to_mourn_inferior */
939 0, /* to_notice_signals */
940 0, /* to_thread_alive */
941 gdbsim_stop, /* to_stop */
942 process_stratum, /* to_stratum */
944 1, /* to_has_all_memory */
945 1, /* to_has_memory */
946 1, /* to_has_stack */
947 1, /* to_has_registers */
948 1, /* to_has_execution */
950 NULL, /* sections_end */
951 OPS_MAGIC, /* to_magic */
955 _initialize_remote_sim ()
957 add_target (&gdbsim_ops);
959 add_com ("sim <command>", class_obscure, simulator_command,
960 "Send a command to the simulator.");