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)
344 for (regno = 0; regno < NUM_REGS; regno++)
345 gdbsim_fetch_register (regno);
349 char buf[MAX_REGISTER_RAW_SIZE];
351 sim_fetch_register (gdbsim_desc, regno, buf);
352 supply_register (regno, buf);
355 printf_filtered ("gdbsim_fetch_register: %d", regno);
356 /* FIXME: We could print something more intelligible. */
357 dump_mem (buf, REGISTER_RAW_SIZE (regno));
364 gdbsim_store_register (regno)
369 for (regno = 0; regno < NUM_REGS; regno++)
370 gdbsim_store_register (regno);
374 /* FIXME: Until read_register() returns LONGEST, we have this. */
375 char tmp[MAX_REGISTER_RAW_SIZE];
376 read_register_gen (regno, tmp);
377 sim_store_register (gdbsim_desc, regno, tmp);
380 printf_filtered ("gdbsim_store_register: %d", regno);
381 /* FIXME: We could print something more intelligible. */
382 dump_mem (tmp, REGISTER_RAW_SIZE (regno));
387 /* Kill the running program. This may involve closing any open files
388 and releasing other resources acquired by the simulated program. */
394 printf_filtered ("gdbsim_kill\n");
396 /* There is no need to `kill' running simulator - the simulator is
401 /* Load an executable file into the target process. This is expected to
402 not only bring new code into the target process, but also to update
403 GDB's symbol tables to match. */
406 gdbsim_load (prog, fromtty)
411 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog);
415 /* FIXME: We will print two messages on error.
416 Need error to either not print anything if passed NULL or need
417 another routine that doesn't take any arguments. */
418 if (sim_load (gdbsim_desc, prog, NULL, fromtty) == SIM_RC_FAIL)
419 error ("unable to load program");
421 /* FIXME: If a load command should reset the targets registers then
422 a call to sim_create_inferior() should go here. */
428 /* Start an inferior process and set inferior_pid to its pid.
429 EXEC_FILE is the file to run.
430 ARGS is a string containing the arguments to the program.
431 ENV is the environment vector to pass. Errors reported with error().
432 On VxWorks and various standalone systems, we ignore exec_file. */
433 /* This is called not only when we first attach, but also when the
434 user types "run" after having attached. */
437 gdbsim_create_inferior (exec_file, args, env)
443 char *arg_buf,**argv;
445 if (exec_file == 0 || exec_bfd == 0)
446 warning ("No exec file specified.");
447 if (! program_loaded)
448 warning ("No program loaded.");
451 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
452 (exec_file ? exec_file: "(NULL)"),
456 remove_breakpoints ();
457 init_wait_for_inferior ();
459 if (exec_file != NULL)
461 len = strlen (exec_file) + 1 + strlen (args) + 1 + /*slop*/ 10;
462 arg_buf = (char *) alloca (len);
464 strcat (arg_buf, exec_file);
465 strcat (arg_buf, " ");
466 strcat (arg_buf, args);
467 argv = buildargv (arg_buf);
468 make_cleanup (freeargv, (char *) argv);
472 sim_create_inferior (gdbsim_desc, exec_bfd, argv, env);
475 insert_breakpoints (); /* Needed to get correct instruction in cache */
477 /* NB: Entry point already set by sim_create_inferior. */
478 proceed ((CORE_ADDR)-1, TARGET_SIGNAL_DEFAULT, 0);
481 /* The open routine takes the rest of the parameters from the command,
482 and (if successful) pushes a new target onto the stack.
483 Targets should supply this routine, if only to provide an error message. */
484 /* Called when selecting the simulator. EG: (gdb) target sim name. */
487 gdbsim_open (args, from_tty)
496 printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
498 /* Remove current simulator if one exists. Only do this if the simulator
499 has been opened because sim_close requires it.
500 This is important because the call to push_target below will cause
501 sim_close to be called if the simulator is already open, but push_target
502 is called after sim_open! We can't move the call to push_target before
503 the call to sim_open because sim_open may invoke `error'. */
504 if (gdbsim_desc != NULL)
505 unpush_target (&gdbsim_ops);
507 len = 7 + 1 + (args ? strlen (args) : 0) + 50;
508 arg_buf = (char *) alloca (len);
509 sprintf (arg_buf, "gdbsim%s%s",
510 args ? " " : "", args ? args : "");
511 #ifdef TARGET_BYTE_ORDER_SELECTABLE
512 /* Since GDB always closes the target and updates byte-order when
513 opening a new file, TARGET_BYTE_ORDER is normally correct. */
514 if (TARGET_BYTE_ORDER == BIG_ENDIAN)
515 strcat (arg_buf, " -E big");
517 strcat (arg_buf, " -E little");
519 argv = buildargv (arg_buf);
521 error ("Insufficient memory available to allocate simulator arg list.");
522 make_cleanup (freeargv, (char *) argv);
525 gdbsim_desc = sim_open (SIM_OPEN_DEBUG, &gdb_callback, exec_bfd, argv);
527 if (gdbsim_desc == 0)
528 error ("unable to create simulator instance");
530 push_target (&gdbsim_ops);
531 target_fetch_registers (-1);
532 printf_filtered ("Connected to the simulator.\n");
535 /* Does whatever cleanup is required for a target that we are no longer
536 going to be calling. Argument says whether we are quitting gdb and
537 should not get hung in case of errors, or whether we want a clean
538 termination even if it takes a while. This routine is automatically
539 always called just before a routine is popped off the target stack.
540 Closing file descriptors and freeing memory are typical things it should
542 /* Close out all files and local state before this target loses control. */
545 gdbsim_close (quitting)
549 printf_filtered ("gdbsim_close: quitting %d\n", quitting);
553 if (gdbsim_desc != NULL)
555 sim_close (gdbsim_desc, quitting);
562 /* Takes a program previously attached to and detaches it.
563 The program may resume execution (some targets do, some don't) and will
564 no longer stop on signals, etc. We better not have left any breakpoints
565 in the program or it'll die when it hits one. ARGS is arguments
566 typed by the user (e.g. a signal to send the process). FROM_TTY
567 says whether to be verbose or not. */
568 /* Terminate the open connection to the remote debugger.
569 Use this when you want to detach and do something else with your gdb. */
572 gdbsim_detach (args,from_tty)
577 printf_filtered ("gdbsim_detach: args \"%s\"\n", args);
579 pop_target (); /* calls gdbsim_close to do the real work */
581 printf_filtered ("Ending simulator %s debugging\n", target_shortname);
584 /* Resume execution of the target process. STEP says whether to single-step
585 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
586 to the target, or zero for no signal. */
588 static enum target_signal resume_siggnal;
589 static int resume_step;
592 gdbsim_resume (pid, step, siggnal)
594 enum target_signal siggnal;
596 if (inferior_pid != 42)
597 error ("The program is not being run.");
600 printf_filtered ("gdbsim_resume: step %d, signal %d\n", step, siggnal);
602 resume_siggnal = siggnal;
606 /* Notify the simulator of an asynchronous request to stop.
608 The simulator shall ensure that the stop request is eventually
609 delivered to the simulator. If the call is made while the
610 simulator is not running then the stop request is processed when
611 the simulator is next resumed.
613 For simulators that do not support this operation, just abort */
618 if (! sim_stop (gdbsim_desc))
624 /* GDB version of os_poll_quit callback.
625 Taken from gdb/util.c - should be in a library */
632 if (quit_flag) /* gdb's idea of quit */
634 quit_flag = 0; /* we've stolen it */
637 else if (immediate_quit)
644 /* Wait for inferior process to do something. Return pid of child,
645 or -1 in case of error; store status through argument pointer STATUS,
646 just as `wait' would. */
649 gdbsim_cntrl_c (int signo)
655 gdbsim_wait (pid, status)
657 struct target_waitstatus *status;
659 static RETSIGTYPE (*prev_sigint) ();
661 enum sim_stop reason = sim_running;
664 printf_filtered ("gdbsim_wait\n");
666 prev_sigint = signal (SIGINT, gdbsim_cntrl_c);
667 sim_resume (gdbsim_desc, resume_step,
668 target_signal_to_host (resume_siggnal));
669 signal (SIGINT, prev_sigint);
672 sim_stop_reason (gdbsim_desc, &reason, &sigrc);
677 status->kind = TARGET_WAITKIND_EXITED;
678 status->value.integer = sigrc;
689 status->kind = TARGET_WAITKIND_STOPPED;
690 /* The signal in sigrc is a host signal. That probably
692 status->value.sig = target_signal_from_host (sigrc);
697 status->kind = TARGET_WAITKIND_SIGNALLED;
698 /* The signal in sigrc is a host signal. That probably
700 status->value.sig = target_signal_from_host (sigrc);
704 /* FIXME: Is this correct? */
711 /* Get ready to modify the registers array. On machines which store
712 individual registers, this doesn't need to do anything. On machines
713 which store all the registers in one fell swoop, this makes sure
714 that registers contains all the registers from the program being
718 gdbsim_prepare_to_store ()
720 /* Do nothing, since we can store individual regs */
724 gdbsim_xfer_inferior_memory (memaddr, myaddr, len, write, target)
729 struct target_ops *target; /* ignored */
731 if (! program_loaded)
732 error ("No program loaded.");
736 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x%x, memaddr 0x%x, len %d, write %d\n",
737 myaddr, memaddr, len, write);
738 if (sr_get_debug () && write)
739 dump_mem(myaddr, len);
744 len = sim_write (gdbsim_desc, memaddr, myaddr, len);
748 len = sim_read (gdbsim_desc, memaddr, myaddr, len);
749 if (sr_get_debug () && len > 0)
750 dump_mem(myaddr, len);
756 gdbsim_files_info (target)
757 struct target_ops *target;
759 char *file = "nothing";
762 file = bfd_get_filename (exec_bfd);
765 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file);
769 printf_filtered ("\tAttached to %s running program %s\n",
770 target_shortname, file);
771 sim_info (gdbsim_desc, 0);
775 /* Clear the simulator's notion of what the break points are. */
778 gdbsim_mourn_inferior ()
781 printf_filtered ("gdbsim_mourn_inferior:\n");
783 remove_breakpoints ();
784 generic_mourn_inferior ();
787 /* Pass the command argument through to the simulator verbatim. The
788 simulator must do any command interpretation work. */
791 simulator_command (args, from_tty)
795 if (gdbsim_desc == NULL)
798 /* PREVIOUSLY: The user may give a command before the simulator
799 is opened. [...] (??? assuming of course one wishes to
800 continue to allow commands to be sent to unopened simulators,
801 which isn't entirely unreasonable). */
803 /* The simulator is a builtin abstraction of a remote target.
804 Consistent with that model, access to the simulator, via sim
805 commands, is restricted to the period when the channel to the
806 simulator is open. */
808 error ("Not connected to the simulator target");
811 sim_do_command (gdbsim_desc, args);
814 /* Define the target subroutine names */
816 struct target_ops gdbsim_ops = {
817 "sim", /* to_shortname */
818 "simulator", /* to_longname */
819 "Use the compiled-in simulator.", /* to_doc */
820 gdbsim_open, /* to_open */
821 gdbsim_close, /* to_close */
822 NULL, /* to_attach */
823 gdbsim_detach, /* to_detach */
824 gdbsim_resume, /* to_resume */
825 gdbsim_wait, /* to_wait */
826 gdbsim_fetch_register, /* to_fetch_registers */
827 gdbsim_store_register, /* to_store_registers */
828 gdbsim_prepare_to_store, /* to_prepare_to_store */
829 gdbsim_xfer_inferior_memory, /* to_xfer_memory */
830 gdbsim_files_info, /* to_files_info */
831 memory_insert_breakpoint, /* to_insert_breakpoint */
832 memory_remove_breakpoint, /* to_remove_breakpoint */
833 NULL, /* to_terminal_init */
834 NULL, /* to_terminal_inferior */
835 NULL, /* to_terminal_ours_for_output */
836 NULL, /* to_terminal_ours */
837 NULL, /* to_terminal_info */
838 gdbsim_kill, /* to_kill */
839 gdbsim_load, /* to_load */
840 NULL, /* to_lookup_symbol */
841 gdbsim_create_inferior, /* to_create_inferior */
842 gdbsim_mourn_inferior, /* to_mourn_inferior */
844 0, /* to_notice_signals */
845 0, /* to_thread_alive */
846 gdbsim_stop, /* to_stop */
847 process_stratum, /* to_stratum */
849 1, /* to_has_all_memory */
850 1, /* to_has_memory */
851 1, /* to_has_stack */
852 1, /* to_has_registers */
853 1, /* to_has_execution */
855 NULL, /* sections_end */
856 OPS_MAGIC, /* to_magic */
860 _initialize_remote_sim ()
862 add_target (&gdbsim_ops);
864 add_com ("sim <command>", class_obscure, simulator_command,
865 "Send a command to the simulator.");