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"
41 static void dump_mem PARAMS ((char *buf, int len));
43 static void init_callbacks PARAMS ((void));
45 static void end_callbacks PARAMS ((void));
47 static int gdb_os_write_stdout PARAMS ((host_callback *, const char *, int));
49 static void gdb_os_flush_stdout PARAMS ((host_callback *));
51 static int gdb_os_write_stderr PARAMS ((host_callback *, const char *, int));
53 static void gdb_os_flush_stderr PARAMS ((host_callback *));
55 static int gdb_os_poll_quit PARAMS ((host_callback *));
57 /* printf_filtered is depreciated */
58 static void gdb_os_printf_filtered PARAMS ((host_callback *, const char *, ...));
60 static void gdb_os_vprintf_filtered PARAMS ((host_callback *, const char *, va_list));
62 static void gdb_os_evprintf_filtered PARAMS ((host_callback *, const char *, va_list));
64 static void gdb_os_error PARAMS ((host_callback *, const char *, ...));
66 static void gdbsim_fetch_register PARAMS ((int regno));
68 static void gdbsim_store_register PARAMS ((int regno));
70 static void gdbsim_kill PARAMS ((void));
72 static void gdbsim_load PARAMS ((char *prog, int fromtty));
74 static void gdbsim_create_inferior PARAMS ((char *exec_file, char *args, char **env));
76 static void gdbsim_open PARAMS ((char *args, int from_tty));
78 static void gdbsim_close PARAMS ((int quitting));
80 static void gdbsim_detach PARAMS ((char *args, int from_tty));
82 static void gdbsim_resume PARAMS ((int pid, int step, enum target_signal siggnal));
84 static int gdbsim_wait PARAMS ((int pid, struct target_waitstatus *status));
86 static void gdbsim_prepare_to_store PARAMS ((void));
88 static int gdbsim_xfer_inferior_memory PARAMS ((CORE_ADDR memaddr,
89 char *myaddr, int len,
91 struct target_ops *target));
93 static void gdbsim_files_info PARAMS ((struct target_ops *target));
95 static void gdbsim_mourn_inferior PARAMS ((void));
97 static void gdbsim_stop PARAMS ((void));
99 static void simulator_command PARAMS ((char *args, int from_tty));
101 /* Naming convention:
103 sim_* are the interface to the simulator (see remote-sim.h).
104 gdbsim_* are stuff which is internal to gdb. */
106 /* Forward data declarations */
107 extern struct target_ops gdbsim_ops;
109 static int program_loaded = 0;
111 /* We must keep track of whether the simulator has been opened or not because
112 GDB can call a target's close routine twice, but sim_close doesn't allow
113 this. We also need to record the result of sim_open so we can pass it
114 back to the other sim_foo routines. */
115 static SIM_DESC gdbsim_desc = 0;
124 if (len == 8 || len == 4)
127 memcpy (l, buf, len);
128 printf_filtered ("\t0x%x", l[0]);
129 printf_filtered (len == 8 ? " 0x%x\n" : "\n", l[1]);
134 printf_filtered ("\t");
135 for (i = 0; i < len; i++)
136 printf_filtered ("0x%x ", buf[i]);
137 printf_filtered ("\n");
142 static host_callback gdb_callback;
143 static int callbacks_initialized = 0;
145 /* Initialize gdb_callback. */
150 if (! callbacks_initialized)
152 gdb_callback = default_callback;
153 gdb_callback.init (&gdb_callback);
154 gdb_callback.write_stdout = gdb_os_write_stdout;
155 gdb_callback.flush_stdout = gdb_os_flush_stdout;
156 gdb_callback.write_stderr = gdb_os_write_stderr;
157 gdb_callback.flush_stderr = gdb_os_flush_stderr;
158 gdb_callback.printf_filtered = gdb_os_printf_filtered;
159 gdb_callback.vprintf_filtered = gdb_os_vprintf_filtered;
160 gdb_callback.evprintf_filtered = gdb_os_evprintf_filtered;
161 gdb_callback.error = gdb_os_error;
162 gdb_callback.poll_quit = gdb_os_poll_quit;
163 gdb_callback.magic = HOST_CALLBACK_MAGIC;
164 sim_set_callbacks (gdbsim_desc, &gdb_callback);
166 callbacks_initialized = 1;
170 /* Release callbacks (free resources used by them). */
175 if (callbacks_initialized)
177 gdb_callback.shutdown (&gdb_callback);
178 callbacks_initialized = 0;
182 /* GDB version of os_write_stdout callback. */
185 gdb_os_write_stdout (p, buf, len)
193 for (i = 0; i < len; i++)
197 if (target_output_hook)
198 target_output_hook (b);
200 fputs_filtered (b, gdb_stdout);
205 /* GDB version of os_flush_stdout callback. */
208 gdb_os_flush_stdout (p)
211 gdb_flush (gdb_stdout);
214 /* GDB version of os_write_stderr callback. */
217 gdb_os_write_stderr (p, buf, len)
225 for (i = 0; i < len; i++)
229 if (target_output_hook)
230 target_output_hook (b);
232 fputs_filtered (b, gdb_stderr);
237 /* GDB version of os_flush_stderr callback. */
240 gdb_os_flush_stderr (p)
243 gdb_flush (gdb_stderr);
246 /* GDB version of os_poll_quit callback.
247 Taken from gdb/util.c - should be in a library */
256 quit_flag = 0; /* we've stolen it */
259 else if (immediate_quit)
266 /* GDB version of printf_filtered callback. */
270 #ifdef ANSI_PROTOTYPES
271 gdb_os_printf_filtered (host_callback *p, const char *format, ...)
273 gdb_os_printf_filtered (p, va_alist)
279 #ifdef ANSI_PROTOTYPES
280 va_start (args, format);
285 format = va_arg (args, char *);
288 vfprintf_filtered (gdb_stdout, format, args);
293 /* GDB version of error vprintf_filtered. */
297 #ifdef ANSI_PROTOTYPES
298 gdb_os_vprintf_filtered (host_callback *p, const char *format, va_list ap)
300 gdb_os_vprintf_filtered (p, format, ap)
306 vfprintf_filtered (gdb_stdout, format, ap);
309 /* GDB version of error evprintf_filtered. */
313 #ifdef ANSI_PROTOTYPES
314 gdb_os_evprintf_filtered (host_callback *p, const char *format, va_list ap)
316 gdb_os_evprintf_filtered (p, format, ap)
322 vfprintf_filtered (gdb_stderr, format, ap);
325 /* GDB version of error callback. */
329 #ifdef ANSI_PROTOTYPES
330 gdb_os_error (host_callback *p, const char *format, ...)
332 gdb_os_error (p, va_alist)
342 #ifdef ANSI_PROTOTYPES
343 va_start (args, format);
348 format = va_arg (args, char *);
352 vfprintf_filtered (gdb_stderr, format, args);
353 fprintf_filtered (gdb_stderr, "\n");
355 return_to_top_level (RETURN_ERROR);
360 gdbsim_fetch_register (regno)
365 for (regno = 0; regno < NUM_REGS; regno++)
366 gdbsim_fetch_register (regno);
370 char buf[MAX_REGISTER_RAW_SIZE];
372 sim_fetch_register (gdbsim_desc, regno, buf);
373 supply_register (regno, buf);
376 printf_filtered ("gdbsim_fetch_register: %d", regno);
377 /* FIXME: We could print something more intelligible. */
378 dump_mem (buf, REGISTER_RAW_SIZE (regno));
385 gdbsim_store_register (regno)
390 for (regno = 0; regno < NUM_REGS; regno++)
391 gdbsim_store_register (regno);
395 /* FIXME: Until read_register() returns LONGEST, we have this. */
396 char tmp[MAX_REGISTER_RAW_SIZE];
397 read_register_gen (regno, tmp);
398 sim_store_register (gdbsim_desc, regno, tmp);
401 printf_filtered ("gdbsim_store_register: %d", regno);
402 /* FIXME: We could print something more intelligible. */
403 dump_mem (tmp, REGISTER_RAW_SIZE (regno));
408 /* Kill the running program. This may involve closing any open files
409 and releasing other resources acquired by the simulated program. */
415 printf_filtered ("gdbsim_kill\n");
417 sim_kill (gdbsim_desc); /* close fd's, remove mappings, etc. */
421 /* Load an executable file into the target process. This is expected to
422 not only bring new code into the target process, but also to update
423 GDB's symbol tables to match. */
426 gdbsim_load (prog, fromtty)
431 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog);
435 /* FIXME: We will print two messages on error.
436 Need error to either not print anything if passed NULL or need
437 another routine that doesn't take any arguments. */
438 if (sim_load (gdbsim_desc, prog, NULL, fromtty) == SIM_RC_FAIL)
439 error ("unable to load program");
445 /* Start an inferior process and set inferior_pid to its pid.
446 EXEC_FILE is the file to run.
447 ARGS is a string containing the arguments to the program.
448 ENV is the environment vector to pass. Errors reported with error().
449 On VxWorks and various standalone systems, we ignore exec_file. */
450 /* This is called not only when we first attach, but also when the
451 user types "run" after having attached. */
454 gdbsim_create_inferior (exec_file, args, env)
460 char *arg_buf,**argv;
463 if (! program_loaded)
464 error ("No program loaded.");
467 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
470 if (exec_file == 0 || exec_bfd == 0)
471 error ("No exec file specified.");
473 entry_pt = (CORE_ADDR) bfd_get_start_address (exec_bfd);
476 remove_breakpoints ();
477 init_wait_for_inferior ();
479 len = strlen (exec_file) + 1 + strlen (args) + 1 + /*slop*/ 10;
480 arg_buf = (char *) alloca (len);
482 strcat (arg_buf, exec_file);
483 strcat (arg_buf, " ");
484 strcat (arg_buf, args);
485 argv = buildargv (arg_buf);
486 make_cleanup (freeargv, (char *) argv);
487 sim_create_inferior (gdbsim_desc, argv, env);
490 insert_breakpoints (); /* Needed to get correct instruction in cache */
491 proceed (entry_pt, TARGET_SIGNAL_DEFAULT, 0);
494 /* The open routine takes the rest of the parameters from the command,
495 and (if successful) pushes a new target onto the stack.
496 Targets should supply this routine, if only to provide an error message. */
497 /* Called when selecting the simulator. EG: (gdb) target sim name. */
500 gdbsim_open (args, from_tty)
509 printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
511 /* Remove current simulator if one exists. Only do this if the simulator
512 has been opened because sim_close requires it.
513 This is important because the call to push_target below will cause
514 sim_close to be called if the simulator is already open, but push_target
515 is called after sim_open! We can't move the call to push_target before
516 the call to sim_open because sim_open may invoke `error'. */
517 if (gdbsim_desc != NULL)
518 unpush_target (&gdbsim_ops);
522 len = 7 + 1 + (args ? strlen (args) : 0) + 50;
523 arg_buf = (char *) alloca (len);
524 sprintf (arg_buf, "gdbsim%s%s",
525 args ? " " : "", args ? args : "");
526 #ifdef TARGET_BYTE_ORDER_SELECTABLE
527 if (TARGET_BYTE_ORDER == BIG_ENDIAN)
528 strcat (arg_buf, " -E big");
530 strcat (arg_buf, " -E little");
532 argv = buildargv (arg_buf);
534 error ("Insufficient memory available to allocate simulator arg list.");
535 make_cleanup (freeargv, (char *) argv);
537 gdbsim_desc = sim_open (SIM_OPEN_DEBUG, argv);
538 if (gdbsim_desc == 0)
539 error ("unable to create simulator instance");
541 push_target (&gdbsim_ops);
542 target_fetch_registers (-1);
543 printf_filtered ("Connected to the simulator.\n");
546 /* Does whatever cleanup is required for a target that we are no longer
547 going to be calling. Argument says whether we are quitting gdb and
548 should not get hung in case of errors, or whether we want a clean
549 termination even if it takes a while. This routine is automatically
550 always called just before a routine is popped off the target stack.
551 Closing file descriptors and freeing memory are typical things it should
553 /* Close out all files and local state before this target loses control. */
556 gdbsim_close (quitting)
560 printf_filtered ("gdbsim_close: quitting %d\n", quitting);
564 if (gdbsim_desc != NULL)
566 sim_close (gdbsim_desc, quitting);
573 /* Takes a program previously attached to and detaches it.
574 The program may resume execution (some targets do, some don't) and will
575 no longer stop on signals, etc. We better not have left any breakpoints
576 in the program or it'll die when it hits one. ARGS is arguments
577 typed by the user (e.g. a signal to send the process). FROM_TTY
578 says whether to be verbose or not. */
579 /* Terminate the open connection to the remote debugger.
580 Use this when you want to detach and do something else with your gdb. */
583 gdbsim_detach (args,from_tty)
588 printf_filtered ("gdbsim_detach: args \"%s\"\n", args);
590 pop_target (); /* calls gdbsim_close to do the real work */
592 printf_filtered ("Ending simulator %s debugging\n", target_shortname);
595 /* Resume execution of the target process. STEP says whether to single-step
596 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
597 to the target, or zero for no signal. */
599 static enum target_signal resume_siggnal;
600 static int resume_step;
603 gdbsim_resume (pid, step, siggnal)
605 enum target_signal siggnal;
607 if (inferior_pid != 42)
608 error ("The program is not being run.");
611 printf_filtered ("gdbsim_resume: step %d, signal %d\n", step, siggnal);
613 resume_siggnal = siggnal;
617 /* Notify the simulator of an asynchronous request to stop.
618 Since some simulators can not stop, help them out.
619 When stepping, need to also notify the client that it
625 if (! sim_stop (gdbsim_desc))
627 error ("gdbsim_stop: simulator failed to stop!\n");
631 /* Wait for inferior process to do something. Return pid of child,
632 or -1 in case of error; store status through argument pointer STATUS,
633 just as `wait' would. */
635 static void (*prev_sigint) ();
638 gdbsim_cntrl_c (int signo)
644 gdbsim_wait (pid, status)
646 struct target_waitstatus *status;
649 enum sim_stop reason = sim_running;
652 printf_filtered ("gdbsim_wait\n");
654 prev_sigint = signal (SIGINT, gdbsim_cntrl_c);
655 sim_resume (gdbsim_desc, resume_step,
656 target_signal_to_host (resume_siggnal));
657 signal (SIGINT, prev_sigint);
660 sim_stop_reason (gdbsim_desc, &reason, &sigrc);
665 status->kind = TARGET_WAITKIND_EXITED;
666 status->value.integer = sigrc;
677 status->kind = TARGET_WAITKIND_STOPPED;
678 /* The signal in sigrc is a host signal. That probably
680 status->value.sig = target_signal_from_host (sigrc);
685 status->kind = TARGET_WAITKIND_SIGNALLED;
686 /* The signal in sigrc is a host signal. That probably
688 status->value.sig = target_signal_from_host (sigrc);
695 /* Get ready to modify the registers array. On machines which store
696 individual registers, this doesn't need to do anything. On machines
697 which store all the registers in one fell swoop, this makes sure
698 that registers contains all the registers from the program being
702 gdbsim_prepare_to_store ()
704 /* Do nothing, since we can store individual regs */
708 gdbsim_xfer_inferior_memory (memaddr, myaddr, len, write, target)
713 struct target_ops *target; /* ignored */
715 if (! program_loaded)
716 error ("No program loaded.");
720 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x%x, memaddr 0x%x, len %d, write %d\n",
721 myaddr, memaddr, len, write);
722 if (sr_get_debug () && write)
723 dump_mem(myaddr, len);
728 len = sim_write (gdbsim_desc, memaddr, myaddr, len);
732 len = sim_read (gdbsim_desc, memaddr, myaddr, len);
733 if (sr_get_debug () && len > 0)
734 dump_mem(myaddr, len);
740 gdbsim_files_info (target)
741 struct target_ops *target;
743 char *file = "nothing";
746 file = bfd_get_filename (exec_bfd);
749 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file);
753 printf_filtered ("\tAttached to %s running program %s\n",
754 target_shortname, file);
755 sim_info (gdbsim_desc, 0);
759 /* Clear the simulator's notion of what the break points are. */
762 gdbsim_mourn_inferior ()
765 printf_filtered ("gdbsim_mourn_inferior:\n");
767 remove_breakpoints ();
768 generic_mourn_inferior ();
771 /* Pass the command argument through to the simulator verbatim. The
772 simulator must do any command interpretation work. */
775 simulator_command (args, from_tty)
779 /* The user may give a command before the simulator is opened, so
780 ensure that the callbacks have been set up. */
783 /* Note that if the simulator hasn't been opened, gdbsim_desc == NULL
784 which is correct (??? assuming of course one wishes to continue to
785 allow commands to be sent to unopened simulators, which isn't entirely
786 unreasonable). Simulators should be prepared to deal with any
787 combination of NULL or empty args. */
788 sim_do_command (gdbsim_desc, args);
791 /* Define the target subroutine names */
793 struct target_ops gdbsim_ops = {
794 "sim", /* to_shortname */
795 "simulator", /* to_longname */
796 "Use the compiled-in simulator.", /* to_doc */
797 gdbsim_open, /* to_open */
798 gdbsim_close, /* to_close */
799 NULL, /* to_attach */
800 gdbsim_detach, /* to_detach */
801 gdbsim_resume, /* to_resume */
802 gdbsim_wait, /* to_wait */
803 gdbsim_fetch_register, /* to_fetch_registers */
804 gdbsim_store_register, /* to_store_registers */
805 gdbsim_prepare_to_store, /* to_prepare_to_store */
806 gdbsim_xfer_inferior_memory, /* to_xfer_memory */
807 gdbsim_files_info, /* to_files_info */
808 memory_insert_breakpoint, /* to_insert_breakpoint */
809 memory_remove_breakpoint, /* to_remove_breakpoint */
810 NULL, /* to_terminal_init */
811 NULL, /* to_terminal_inferior */
812 NULL, /* to_terminal_ours_for_output */
813 NULL, /* to_terminal_ours */
814 NULL, /* to_terminal_info */
815 gdbsim_kill, /* to_kill */
816 gdbsim_load, /* to_load */
817 NULL, /* to_lookup_symbol */
818 gdbsim_create_inferior, /* to_create_inferior */
819 gdbsim_mourn_inferior, /* to_mourn_inferior */
821 0, /* to_notice_signals */
822 0, /* to_thread_alive */
823 gdbsim_stop, /* to_stop */
824 process_stratum, /* to_stratum */
826 1, /* to_has_all_memory */
827 1, /* to_has_memory */
828 1, /* to_has_stack */
829 1, /* to_has_registers */
830 1, /* to_has_execution */
832 NULL, /* sections_end */
833 OPS_MAGIC, /* to_magic */
837 _initialize_remote_sim ()
839 add_target (&gdbsim_ops);
841 add_com ("sim <command>", class_obscure, simulator_command,
842 "Send a command to the simulator.");