dcd327d432bdadcd27c0fa7b386dc233d3b6969f
[external/binutils.git] / sim / common / run-sim.h
1 /* This file defines the part of the interface between the standalone
2    simaulator program - run - and simulator library - libsim.a - that
3    is not used by GDB.  The GDB part is described in include/remote-sim.h.
4    
5    Copyright 2002, 2007 Free Software Foundation, Inc.
6
7    This file is part of GDB.
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
22
23 #ifndef RUN_SIM_H
24 #define RUN_SIM_H
25
26 #ifdef SIM_TARGET_SWITCHES
27   /* Parse the command line, extracting any target specific switches
28      before the generic simulator code gets a chance to complain
29      about them.  Returns the adjusted value of argc.  */
30 int sim_target_parse_command_line PARAMS ((int, char **));
31
32   /* Display a list of target specific switches supported by this
33      target.  */
34 void sim_target_display_usage PARAMS ((void));
35
36 #endif
37
38 /* Provide simulator with a default (global) host_callback_struct.
39    THIS PROCEDURE IS DEPRECATED.
40    GDB and NRUN do not use this interface.
41    This procedure does not take a SIM_DESC argument as it is
42    used before sim_open. */
43
44 void sim_set_callbacks PARAMS ((struct host_callback_struct *));
45
46
47 /* Set the size of the simulator memory array.
48    THIS PROCEDURE IS DEPRECATED.
49    GDB and NRUN do not use this interface.
50    This procedure does not take a SIM_DESC argument as it is
51    used before sim_open. */
52
53 void sim_size PARAMS ((int i));
54
55
56 /* Single-step simulator with tracing enabled.
57    THIS PROCEDURE IS DEPRECATED.
58    THIS PROCEDURE IS EVEN MORE DEPRECATED THAN SIM_SET_TRACE
59    GDB and NRUN do not use this interface.
60    This procedure returns: ``0'' indicating that the simulator should
61    be continued using sim_trace() calls; ``1'' indicating that the
62    simulation has finished. */
63
64 int sim_trace PARAMS ((SIM_DESC sd));
65
66
67 /* Enable tracing.
68    THIS PROCEDURE IS DEPRECATED.
69    GDB and NRUN do not use this interface.
70    This procedure returns: ``0'' indicating that the simulator should
71    be continued using sim_trace() calls; ``1'' indicating that the
72    simulation has finished. */
73
74 void sim_set_trace PARAMS ((void));
75
76
77 /* Configure the size of the profile buffer.
78    THIS PROCEDURE IS DEPRECATED.
79    GDB and NRUN do not use this interface.
80    This procedure does not take a SIM_DESC argument as it is
81    used before sim_open. */
82
83 void sim_set_profile_size PARAMS ((int n));
84
85
86 /* Kill the running program.
87    THIS PROCEDURE IS DEPRECATED.
88    GDB and NRUN do not use this interface.
89    This procedure will be replaced as part of the introduction of
90    multi-cpu simulators. */
91
92 void sim_kill PARAMS ((SIM_DESC sd));
93
94 #endif