2 Copyright (C) 1996-2016 Free Software Foundation, Inc.
3 Contributed by Cygnus Support.
5 This file is part of GDB, the GNU debugger.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 /* This file is intended to be included by sim-base.h. */
25 /* Modules are addons to the simulator that perform a specific function
26 (e.g. tracing, profiling, memory subsystem, etc.). Some modules are
27 builtin, and others are added at configure time. The intent is to
28 provide a uniform framework for all of the pieces that make up the
31 TODO: Add facilities for saving/restoring state to/from a file. */
33 #include "gdb/remote-sim.h"
35 /* Various function types. */
37 typedef SIM_RC (MODULE_INSTALL_FN) (SIM_DESC);
38 typedef SIM_RC (MODULE_INIT_FN) (SIM_DESC);
39 typedef SIM_RC (MODULE_RESUME_FN) (SIM_DESC);
40 typedef SIM_RC (MODULE_SUSPEND_FN) (SIM_DESC);
41 typedef void (MODULE_UNINSTALL_FN) (SIM_DESC);
42 typedef void (MODULE_INFO_FN) (SIM_DESC, int);
45 /* Lists of installed handlers. */
47 typedef struct module_init_list {
48 struct module_init_list *next;
52 typedef struct module_resume_list {
53 struct module_resume_list *next;
57 typedef struct module_suspend_list {
58 struct module_suspend_list *next;
59 MODULE_SUSPEND_FN *fn;
60 } MODULE_SUSPEND_LIST;
62 typedef struct module_uninstall_list {
63 struct module_uninstall_list *next;
64 MODULE_UNINSTALL_FN *fn;
65 } MODULE_UNINSTALL_LIST;
67 typedef struct module_info_list {
68 struct module_info_list *next;
73 /* Functions to register module with various handler lists */
75 SIM_RC sim_module_install (SIM_DESC);
76 void sim_module_uninstall (SIM_DESC);
77 void sim_module_add_init_fn (SIM_DESC sd, MODULE_INIT_FN fn);
78 void sim_module_add_resume_fn (SIM_DESC sd, MODULE_RESUME_FN fn);
79 void sim_module_add_suspend_fn (SIM_DESC sd, MODULE_SUSPEND_FN fn);
80 void sim_module_add_uninstall_fn (SIM_DESC sd, MODULE_UNINSTALL_FN fn);
81 void sim_module_add_info_fn (SIM_DESC sd, MODULE_INFO_FN fn);
84 /* Initialize installed modules before argument processing.
85 Called by sim_open. */
86 SIM_RC sim_pre_argv_init (SIM_DESC sd, const char *myname);
88 /* Initialize installed modules after argument processing.
89 Called by sim_open. */
90 SIM_RC sim_post_argv_init (SIM_DESC sd);
92 /* Re-initialize the module. Called by sim_create_inferior. */
93 SIM_RC sim_module_init (SIM_DESC sd);
95 /* Suspend/resume modules. Called by sim_run or sim_resume */
96 SIM_RC sim_module_suspend (SIM_DESC sd);
97 SIM_RC sim_module_resume (SIM_DESC sd);
99 /* Report general information on module */
100 void sim_module_info (SIM_DESC sd, int verbose);
103 /* Module private data */
107 /* List of installed module `init' handlers */
108 MODULE_INIT_LIST *init_list;
110 /* List of installed module `uninstall' handlers. */
111 MODULE_UNINSTALL_LIST *uninstall_list;
113 /* List of installed module `resume' handlers. */
114 MODULE_RESUME_LIST *resume_list;
116 /* List of installed module `suspend' handlers. */
117 MODULE_SUSPEND_LIST *suspend_list;
119 /* List of installed module `info' handlers. */
120 MODULE_INFO_LIST *info_list;
125 #endif /* SIM_MODULES_H */