Fix comment.

1 files changed, 78 insertions, 0 deletions

diff --git a/sim/common/sim-module.h b/sim/common/sim-module.h
new file mode 100644
index 0000000..260f694
--- /dev/null
+++ b/sim/common/sim-module.h
@@ -0,0 +1,78 @@
+/* Module support.
+   Copyright (C) 1996, 1997 Free Software Foundation, Inc.
+   Contributed by Cygnus Support.
+
+This file is part of GDB, the GNU debugger.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
+
+/* This file is intended to be included by sim-base.h.  */
+
+#ifndef SIM_MODULES_H
+#define SIM_MODULES_H
+
+/* Modules are addons to the simulator that perform a specific function
+   (e.g. tracing, profiling, memory subsystem, etc.).  Some modules are
+   builtin, and others are added at configure time.  The intent is to
+   provide a uniform framework for all of the pieces that make up the
+   simulator.
+
+   TODO: Add facilities for saving/restoring state to/from a file.  */
+
+/* Various function types.  */
+typedef SIM_RC (MODULE_INSTALL_FN) (SIM_DESC);
+typedef SIM_RC (MODULE_INIT_FN) (SIM_DESC);
+typedef SIM_RC (MODULE_SUSPEND_FN) (SIM_DESC);
+typedef SIM_RC (MODULE_RESUME_FN) (SIM_DESC);
+typedef void (MODULE_UNINSTALL_FN) (SIM_DESC);
+
+/* Lists of installed handlers.  */
+typedef struct module_init_list {
+  struct module_init_list *next;
+  MODULE_INIT_FN *fn;
+} MODULE_INIT_LIST;
+typedef struct module_resume_list {
+  struct module_resume_list *next;
+  MODULE_RESUME_FN *fn;
+} MODULE_RESUME_LIST;
+typedef struct module_suspend_list {
+  struct module_suspend_list *next;
+  MODULE_SUSPEND_FN *fn;
+} MODULE_SUSPEND_LIST;
+typedef struct module_uninstall_list {
+  struct module_uninstall_list *next;
+  MODULE_UNINSTALL_FN *fn;
+} MODULE_UNINSTALL_LIST;
+
+SIM_RC sim_module_install (SIM_DESC);
+void sim_module_uninstall (SIM_DESC);
+void sim_module_add_init_fn (SIM_DESC sd, MODULE_INIT_FN fn);
+void sim_module_add_resume_fn (SIM_DESC sd, MODULE_RESUME_FN fn);
+void sim_module_add_suspend_fn (SIM_DESC sd, MODULE_SUSPEND_FN fn);
+void sim_module_add_uninstall_fn (SIM_DESC sd, MODULE_UNINSTALL_FN fn);
+
+/* Initialize installed modules before argument processing.
+   Called by sim_open.  */
+SIM_RC sim_pre_argv_init (SIM_DESC sd, const char *myname);
+/* Initialize installed modules after argument processing.
+   Called by sim_open.  */
+SIM_RC sim_post_argv_init (SIM_DESC sd);
+/* Re-initialize the module.  Called by sim_create_inferior. */
+SIM_RC sim_module_init (SIM_DESC sd);
+/* Suspend/resume modules.  Called by sim_run or sim_resume */
+SIM_RC sim_module_suspend (SIM_DESC sd);
+SIM_RC sim_module_resume (SIM_DESC sd);
+
+#endif /* SIM_MODULES_H */