/* This file defines the interface between the simulator and gdb.
- Copyright (C) 1993 Free Software Foundation, Inc.
+ Copyright (C) 1993, 1994 Free Software Foundation, Inc.
This file is part of GDB.
#if !defined (REMOTE_SIM_H)
#define REMOTE_SIM_H 1
-/* Main simulator globals ... */
+/* This file is used when building stand-alone simulators, so isolate this
+ file from gdb. */
-extern int sim_verbose;
+/* Pick up CORE_ADDR_TYPE if defined (from gdb), otherwise use same value as
+ gdb does (unsigned int - from defs.h). */
+
+#ifndef CORE_ADDR_TYPE
+typedef unsigned int SIM_ADDR;
+#else
+typedef CORE_ADDR_TYPE SIM_ADDR;
+#endif
+
+/* Callbacks.
+ The simulator may use the following callbacks (gdb routines) which the
+ standalone program must provide.
+
+ void printf_filtered (char *msg, ...);
+ void error /-* noreturn *-/ (char *msg, ...);
+ void *xmalloc (long size);
+*/
/* Main simulator entry points ...
- All functions return 0 for success and non-zero for failure. */
+ All functions that can get an error must call the gdb routine `error',
+ they can only return upon success. */
/* Initialize the simulator. This function is called when the simulator
is selected from the command line. ARGS is passed from the command line
and can be used to select whatever run time options the simulator provides.
- ARGS is the raw character string and must be parsed by the simulator. */
-
-int sim_open PARAMS ((char *name));
+ ARGS is the raw character string and must be parsed by the simulator,
+ which is trivial to do with the buildargv function in libiberty.
+ It is ok to do nothing. */
-/* Load program PROG into the simulator.
- We use "void *" instead of "bfd *" to isolate this file from BFD. */
-
-int sim_load PARAMS ((void *bfd_handle, char *args));
+void sim_open PARAMS ((char *args));
-/* Set the arguments and environment for the program loaded into the
- simulator. ARGV and ENV are NULL terminated lists of pointers.
- If the simulator doesn't support setting arguments, print an error message
- and return non-zero. */
+/* Terminate usage of the simulator. This may involve freeing target memory
+ and closing any open files and mmap'd areas. You cannot assume sim_kill
+ has already been called.
+ QUITTING is non-zero if we cannot hang on errors. */
-int sim_set_args PARAMS ((char **argv, char **env));
+void sim_close PARAMS ((int quitting));
-/* Fetch register REGNO and store the raw value in BUF. */
+/* Load program PROG into the simulator.
+ Return non-zero if you wish the caller to handle it
+ (it is done this way because most simulators can use gr_load_image,
+ but defining it as a callback seems awkward). */
-int sim_fetch_register PARAMS ((int regno, char *buf));
+int sim_load PARAMS ((char *prog, int from_tty));
-/* Store register REGNO from BUF (in raw format). */
+/* Prepare to run the simulated program.
+ START_ADDRESS is, yes, you guessed it, the start address of the program.
+ ARGV and ENV are NULL terminated lists of pointers.
+ Gdb will set the start address via sim_store_register as well, but
+ standalone versions of existing simulators are not set up to cleanly call
+ sim_store_register, so the START_ADDRESS argument is there as a
+ workaround. */
-int sim_store_register PARAMS ((int regno, char *buf));
+void sim_create_inferior PARAMS ((SIM_ADDR start_address,
+ char **argv, char **env));
/* Kill the running program.
This may involve closing any open files and deleting any mmap'd areas. */
-int sim_kill PARAMS ((void));
+void sim_kill PARAMS ((void));
+
+/* Read LENGTH bytes of the simulated program's memory and store in BUF.
+ Result is number of bytes read, or zero if error. */
+
+int sim_read PARAMS ((SIM_ADDR mem, unsigned char *buf, int length));
+
+/* Store LENGTH bytes from BUF in the simulated program's memory.
+ Result is number of bytes write, or zero if error. */
-/* Read LENGTH bytes of the simulated program's memory and store in BUF. */
+int sim_write PARAMS ((SIM_ADDR mem, unsigned char *buf, int length));
-int sim_read PARAMS ((CORE_ADDR mem, char *buf, int length));
+/* Fetch register REGNO and store the raw value in BUF. */
-/* Store LENGTH bytes from BUF in the simulated program's memory. */
+void sim_fetch_register PARAMS ((int regno, unsigned char *buf));
-int sim_write PARAMS ((CORE_ADDR mem, char *buf, int length));
+/* Store register REGNO from BUF (in raw format). */
-/* Print some interesting information about the simulator. */
+void sim_store_register PARAMS ((int regno, unsigned char *buf));
-int sim_info PARAMS ((void));
+/* Print some interesting information about the simulator.
+ VERBOSE is non-zero for the wordy version. */
-/* Set the simulated cpu's program counter to PC. */
+void sim_info PARAMS ((int verbose));
-int sim_set_pc PARAMS ((CORE_ADDR pc));
+/* Fetch why the program stopped.
+ SIGRC will contain either the argument to exit() or the signal number. */
-/* Fetch why the program stopped. */
+enum sim_stop { sim_exited, sim_stopped, sim_signalled };
-int sim_stop_signal PARAMS ((void));
+void sim_stop_reason PARAMS ((enum sim_stop *reason, int *sigrc));
/* Run (or resume) the program. */
-int sim_resume PARAMS ((int step, int siggnal));
+void sim_resume PARAMS ((int step, int siggnal));
+
+/* Passthru for other commands that the simulator might support. */
+
+void sim_do_command PARAMS ((char *cmd));
#endif /* !defined (REMOTE_SIM_H) */
projects / deliverable / binutils-gdb.git / blobdiff