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 /* printf_filtered is depreciated */
56 static void gdb_os_printf_filtered PARAMS ((host_callback *, const char *, ...));
58 static void gdb_os_vprintf_filtered PARAMS ((host_callback *, const char *, va_list));
60 static void gdb_os_evprintf_filtered PARAMS ((host_callback *, const char *, va_list));
62 static void gdb_os_error PARAMS ((host_callback *, const char *, ...));
64 static void gdbsim_fetch_register PARAMS ((int regno));
66 static void gdbsim_store_register PARAMS ((int regno));
68 static void gdbsim_kill PARAMS ((void));
70 static void gdbsim_load PARAMS ((char *prog, int fromtty));
72 static void gdbsim_create_inferior PARAMS ((char *exec_file, char *args, char **env));
74 static void gdbsim_open PARAMS ((char *args, int from_tty));
76 static void gdbsim_close PARAMS ((int quitting));
78 static void gdbsim_detach PARAMS ((char *args, int from_tty));
80 static void gdbsim_resume PARAMS ((int pid, int step, enum target_signal siggnal));
82 static int gdbsim_wait PARAMS ((int pid, struct target_waitstatus *status));
84 static void gdbsim_prepare_to_store PARAMS ((void));
86 static int gdbsim_xfer_inferior_memory PARAMS ((CORE_ADDR memaddr,
87 char *myaddr, int len,
89 struct target_ops *target));
91 static void gdbsim_files_info PARAMS ((struct target_ops *target));
93 static void gdbsim_mourn_inferior PARAMS ((void));
95 static void simulator_command PARAMS ((char *args, int from_tty));
99 sim_* are the interface to the simulator (see remote-sim.h).
100 gdbsim_* are stuff which is internal to gdb. */
102 /* Forward data declarations */
103 extern struct target_ops gdbsim_ops;
105 static int program_loaded = 0;
107 /* We must keep track of whether the simulator has been opened or not because
108 GDB can call a target's close routine twice, but sim_close doesn't allow
109 this. We also need to record the result of sim_open so we can pass it
110 back to the other sim_foo routines. */
111 static SIM_DESC gdbsim_desc = 0;
120 if (len == 8 || len == 4)
123 memcpy (l, buf, len);
124 printf_filtered ("\t0x%x", l[0]);
125 printf_filtered (len == 8 ? " 0x%x\n" : "\n", l[1]);
130 printf_filtered ("\t");
131 for (i = 0; i < len; i++)
132 printf_filtered ("0x%x ", buf[i]);
133 printf_filtered ("\n");
138 static host_callback gdb_callback;
139 static int callbacks_initialized = 0;
141 /* Initialize gdb_callback. */
146 if (! callbacks_initialized)
148 gdb_callback = default_callback;
149 gdb_callback.init (&gdb_callback);
150 gdb_callback.write_stdout = gdb_os_write_stdout;
151 gdb_callback.flush_stdout = gdb_os_flush_stdout;
152 gdb_callback.write_stderr = gdb_os_write_stderr;
153 gdb_callback.flush_stderr = gdb_os_flush_stderr;
154 gdb_callback.printf_filtered = gdb_os_printf_filtered;
155 gdb_callback.vprintf_filtered = gdb_os_vprintf_filtered;
156 gdb_callback.evprintf_filtered = gdb_os_evprintf_filtered;
157 gdb_callback.error = gdb_os_error;
158 sim_set_callbacks (gdbsim_desc, &gdb_callback);
159 callbacks_initialized = 1;
163 /* Release callbacks (free resources used by them). */
168 if (callbacks_initialized)
170 gdb_callback.shutdown (&gdb_callback);
171 callbacks_initialized = 0;
175 /* GDB version of os_write_stdout callback. */
178 gdb_os_write_stdout (p, buf, len)
186 for (i = 0; i < len; i++)
190 if (target_output_hook)
191 target_output_hook (b);
193 fputs_filtered (b, gdb_stdout);
198 /* GDB version of os_flush_stdout callback. */
201 gdb_os_flush_stdout (p)
204 gdb_flush (gdb_stdout);
207 /* GDB version of os_write_stderr callback. */
210 gdb_os_write_stderr (p, buf, len)
218 for (i = 0; i < len; i++)
222 if (target_output_hook)
223 target_output_hook (b);
225 fputs_filtered (b, gdb_stderr);
230 /* GDB version of os_flush_stderr callback. */
233 gdb_os_flush_stderr (p)
236 gdb_flush (gdb_stderr);
239 /* GDB version of printf_filtered callback. */
243 #ifdef ANSI_PROTOTYPES
244 gdb_os_printf_filtered (host_callback *p, const char *format, ...)
246 gdb_os_printf_filtered (p, va_alist)
252 #ifdef ANSI_PROTOTYPES
253 va_start (args, format);
258 format = va_arg (args, char *);
261 vfprintf_filtered (gdb_stdout, format, args);
266 /* GDB version of error vprintf_filtered. */
270 #ifdef ANSI_PROTOTYPES
271 gdb_os_vprintf_filtered (host_callback *p, const char *format, va_list ap)
273 gdb_os_vprintf_filtered (p, format, ap)
279 vfprintf_filtered (gdb_stdout, format, ap);
282 /* GDB version of error evprintf_filtered. */
286 #ifdef ANSI_PROTOTYPES
287 gdb_os_evprintf_filtered (host_callback *p, const char *format, va_list ap)
289 gdb_os_evprintf_filtered (p, format, ap)
295 vfprintf_filtered (gdb_stderr, format, ap);
298 /* GDB version of error callback. */
302 #ifdef ANSI_PROTOTYPES
303 gdb_os_error (host_callback *p, const char *format, ...)
305 gdb_os_error (p, va_alist)
315 #ifdef ANSI_PROTOTYPES
316 va_start (args, format);
321 format = va_arg (args, char *);
325 vfprintf_filtered (gdb_stderr, format, args);
326 fprintf_filtered (gdb_stderr, "\n");
328 return_to_top_level (RETURN_ERROR);
333 gdbsim_fetch_register (regno)
338 for (regno = 0; regno < NUM_REGS; regno++)
339 gdbsim_fetch_register (regno);
343 char buf[MAX_REGISTER_RAW_SIZE];
345 sim_fetch_register (gdbsim_desc, regno, buf);
346 supply_register (regno, buf);
349 printf_filtered ("gdbsim_fetch_register: %d", regno);
350 /* FIXME: We could print something more intelligible. */
351 dump_mem (buf, REGISTER_RAW_SIZE (regno));
358 gdbsim_store_register (regno)
363 for (regno = 0; regno < NUM_REGS; regno++)
364 gdbsim_store_register (regno);
368 /* FIXME: Until read_register() returns LONGEST, we have this. */
369 char tmp[MAX_REGISTER_RAW_SIZE];
370 read_register_gen (regno, tmp);
371 sim_store_register (gdbsim_desc, regno, tmp);
374 printf_filtered ("gdbsim_store_register: %d", regno);
375 /* FIXME: We could print something more intelligible. */
376 dump_mem (tmp, REGISTER_RAW_SIZE (regno));
381 /* Kill the running program. This may involve closing any open files
382 and releasing other resources acquired by the simulated program. */
388 printf_filtered ("gdbsim_kill\n");
390 sim_kill (gdbsim_desc); /* close fd's, remove mappings, etc. */
394 /* Load an executable file into the target process. This is expected to
395 not only bring new code into the target process, but also to update
396 GDB's symbol tables to match. */
399 gdbsim_load (prog, fromtty)
404 printf_filtered ("gdbsim_load: prog \"%s\"\n", prog);
408 /* FIXME: We will print two messages on error.
409 Need error to either not print anything if passed NULL or need
410 another routine that doesn't take any arguments. */
411 if (sim_load (gdbsim_desc, prog, NULL, fromtty) == SIM_RC_FAIL)
412 error ("unable to load program");
418 /* Start an inferior process and set inferior_pid to its pid.
419 EXEC_FILE is the file to run.
420 ARGS is a string containing the arguments to the program.
421 ENV is the environment vector to pass. Errors reported with error().
422 On VxWorks and various standalone systems, we ignore exec_file. */
423 /* This is called not only when we first attach, but also when the
424 user types "run" after having attached. */
427 gdbsim_create_inferior (exec_file, args, env)
433 char *arg_buf,**argv;
436 if (! program_loaded)
437 error ("No program loaded.");
440 printf_filtered ("gdbsim_create_inferior: exec_file \"%s\", args \"%s\"\n",
443 if (exec_file == 0 || exec_bfd == 0)
444 error ("No exec file specified.");
446 entry_pt = (CORE_ADDR) bfd_get_start_address (exec_bfd);
449 remove_breakpoints ();
450 init_wait_for_inferior ();
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, (char *) argv);
460 sim_create_inferior (gdbsim_desc, argv, env);
463 insert_breakpoints (); /* Needed to get correct instruction in cache */
464 proceed (entry_pt, TARGET_SIGNAL_DEFAULT, 0);
467 /* The open routine takes the rest of the parameters from the command,
468 and (if successful) pushes a new target onto the stack.
469 Targets should supply this routine, if only to provide an error message. */
470 /* Called when selecting the simulator. EG: (gdb) target sim name. */
473 gdbsim_open (args, from_tty)
482 printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
484 /* Remove current simulator if one exists. Only do this if the simulator
485 has been opened because sim_close requires it.
486 This is important because the call to push_target below will cause
487 sim_close to be called if the simulator is already open, but push_target
488 is called after sim_open! We can't move the call to push_target before
489 the call to sim_open because sim_open may invoke `error'. */
490 if (gdbsim_desc != NULL)
491 unpush_target (&gdbsim_ops);
495 len = 7 + 1 + (args ? strlen (args) : 0) + 50;
496 arg_buf = (char *) alloca (len);
497 sprintf (arg_buf, "gdbsim%s%s -E %s",
498 args ? " " : "", args ? args : "",
499 TARGET_BYTE_ORDER == BIG_ENDIAN ? "big" : "little");
500 argv = buildargv (arg_buf);
502 error ("Insufficient memory available to allocate simulator arg list.");
503 make_cleanup (freeargv, (char *) argv);
505 gdbsim_desc = sim_open (SIM_OPEN_DEBUG, argv);
506 if (gdbsim_desc == 0)
507 error ("unable to create simulator instance");
509 push_target (&gdbsim_ops);
510 target_fetch_registers (-1);
511 printf_filtered ("Connected to the simulator.\n");
514 /* Does whatever cleanup is required for a target that we are no longer
515 going to be calling. Argument says whether we are quitting gdb and
516 should not get hung in case of errors, or whether we want a clean
517 termination even if it takes a while. This routine is automatically
518 always called just before a routine is popped off the target stack.
519 Closing file descriptors and freeing memory are typical things it should
521 /* Close out all files and local state before this target loses control. */
524 gdbsim_close (quitting)
528 printf_filtered ("gdbsim_close: quitting %d\n", quitting);
532 if (gdbsim_desc != NULL)
534 sim_close (gdbsim_desc, quitting);
541 /* Takes a program previously attached to and detaches it.
542 The program may resume execution (some targets do, some don't) and will
543 no longer stop on signals, etc. We better not have left any breakpoints
544 in the program or it'll die when it hits one. ARGS is arguments
545 typed by the user (e.g. a signal to send the process). FROM_TTY
546 says whether to be verbose or not. */
547 /* Terminate the open connection to the remote debugger.
548 Use this when you want to detach and do something else with your gdb. */
551 gdbsim_detach (args,from_tty)
556 printf_filtered ("gdbsim_detach: args \"%s\"\n", args);
558 pop_target (); /* calls gdbsim_close to do the real work */
560 printf_filtered ("Ending simulator %s debugging\n", target_shortname);
563 /* Resume execution of the target process. STEP says whether to single-step
564 or to run free; SIGGNAL is the signal value (e.g. SIGINT) to be given
565 to the target, or zero for no signal. */
568 gdbsim_resume (pid, step, siggnal)
570 enum target_signal siggnal;
572 if (inferior_pid != 42)
573 error ("The program is not being run.");
576 printf_filtered ("gdbsim_resume: step %d, signal %d\n", step, siggnal);
578 sim_resume (gdbsim_desc, step, target_signal_to_host (siggnal));
581 /* Wait for inferior process to do something. Return pid of child,
582 or -1 in case of error; store status through argument pointer STATUS,
583 just as `wait' would. */
586 gdbsim_wait (pid, status)
588 struct target_waitstatus *status;
591 enum sim_stop reason;
594 printf_filtered ("gdbsim_wait\n");
596 sim_stop_reason (gdbsim_desc, &reason, &sigrc);
600 status->kind = TARGET_WAITKIND_EXITED;
601 status->value.integer = sigrc;
604 status->kind = TARGET_WAITKIND_STOPPED;
605 /* The signal in sigrc is a host signal. That probably
607 status->value.sig = target_signal_from_host (sigrc);
610 status->kind = TARGET_WAITKIND_SIGNALLED;
611 /* The signal in sigrc is a host signal. That probably
613 status->value.sig = target_signal_from_host (sigrc);
620 /* Get ready to modify the registers array. On machines which store
621 individual registers, this doesn't need to do anything. On machines
622 which store all the registers in one fell swoop, this makes sure
623 that registers contains all the registers from the program being
627 gdbsim_prepare_to_store ()
629 /* Do nothing, since we can store individual regs */
633 gdbsim_xfer_inferior_memory (memaddr, myaddr, len, write, target)
638 struct target_ops *target; /* ignored */
640 if (! program_loaded)
641 error ("No program loaded.");
645 printf_filtered ("gdbsim_xfer_inferior_memory: myaddr 0x%x, memaddr 0x%x, len %d, write %d\n",
646 myaddr, memaddr, len, write);
647 if (sr_get_debug () && write)
648 dump_mem(myaddr, len);
653 len = sim_write (gdbsim_desc, memaddr, myaddr, len);
657 len = sim_read (gdbsim_desc, memaddr, myaddr, len);
658 if (sr_get_debug () && len > 0)
659 dump_mem(myaddr, len);
665 gdbsim_files_info (target)
666 struct target_ops *target;
668 char *file = "nothing";
671 file = bfd_get_filename (exec_bfd);
674 printf_filtered ("gdbsim_files_info: file \"%s\"\n", file);
678 printf_filtered ("\tAttached to %s running program %s\n",
679 target_shortname, file);
680 sim_info (gdbsim_desc, 0);
684 /* Clear the simulator's notion of what the break points are. */
687 gdbsim_mourn_inferior ()
690 printf_filtered ("gdbsim_mourn_inferior:\n");
692 remove_breakpoints ();
693 generic_mourn_inferior ();
696 /* Pass the command argument through to the simulator verbatim. The
697 simulator must do any command interpretation work. */
700 simulator_command (args, from_tty)
704 /* The user may give a command before the simulator is opened, so
705 ensure that the callbacks have been set up. */
708 /* Note that if the simulator hasn't been opened, gdbsim_desc == NULL
709 which is correct (??? assuming of course one wishes to continue to
710 allow commands to be sent to unopened simulators, which isn't entirely
711 unreasonable). Simulators should be prepared to deal with any
712 combination of NULL or empty args. */
713 sim_do_command (gdbsim_desc, args);
716 /* Define the target subroutine names */
718 struct target_ops gdbsim_ops = {
719 "sim", /* to_shortname */
720 "simulator", /* to_longname */
721 "Use the compiled-in simulator.", /* to_doc */
722 gdbsim_open, /* to_open */
723 gdbsim_close, /* to_close */
724 NULL, /* to_attach */
725 gdbsim_detach, /* to_detach */
726 gdbsim_resume, /* to_resume */
727 gdbsim_wait, /* to_wait */
728 gdbsim_fetch_register, /* to_fetch_registers */
729 gdbsim_store_register, /* to_store_registers */
730 gdbsim_prepare_to_store, /* to_prepare_to_store */
731 gdbsim_xfer_inferior_memory, /* to_xfer_memory */
732 gdbsim_files_info, /* to_files_info */
733 memory_insert_breakpoint, /* to_insert_breakpoint */
734 memory_remove_breakpoint, /* to_remove_breakpoint */
735 NULL, /* to_terminal_init */
736 NULL, /* to_terminal_inferior */
737 NULL, /* to_terminal_ours_for_output */
738 NULL, /* to_terminal_ours */
739 NULL, /* to_terminal_info */
740 gdbsim_kill, /* to_kill */
741 gdbsim_load, /* to_load */
742 NULL, /* to_lookup_symbol */
743 gdbsim_create_inferior, /* to_create_inferior */
744 gdbsim_mourn_inferior, /* to_mourn_inferior */
746 0, /* to_notice_signals */
747 0, /* to_thread_alive */
749 process_stratum, /* to_stratum */
751 1, /* to_has_all_memory */
752 1, /* to_has_memory */
753 1, /* to_has_stack */
754 1, /* to_has_registers */
755 1, /* to_has_execution */
757 NULL, /* sections_end */
758 OPS_MAGIC, /* to_magic */
762 _initialize_remote_sim ()
764 add_target (&gdbsim_ops);
766 add_com ("sim <command>", class_obscure, simulator_command,
767 "Send a command to the simulator.");