sim/common/sim-module.c

   1 /* Module support.
   2    Copyright (C) 1996, 1997 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support.
   4
   5 This file is part of GDB, the GNU debugger.
   6
   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 2, or (at your option)
  10 any later version.
  11
  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.
  16
  17 You should have received a copy of the GNU General Public License along
  18 with this program; if not, write to the Free Software Foundation, Inc.,
  19 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20
  21 #include "sim-main.h"
  22 #include "sim-io.h"
  23 #include "sim-options.h"
  24 #include "sim-assert.h"
  25
  26 #include "libiberty.h"
  27
  28 /* List of all modules.  */
  29 static MODULE_INSTALL_FN * const modules[] = {
  30   standard_install,
  31 #if WITH_ENGINE
  32   sim_engine_install,
  33 #endif
  34 #if WITH_TRACE
  35   trace_install,
  36 #endif
  37 #if WITH_PROFILE
  38   profile_install,
  39 #endif
  40   sim_core_install,
  41 #ifndef SIM_HAVE_FLATMEM
  42   /* FIXME: should handle flatmem as well FLATMEM */
  43   sim_memopt_install,
  44 #endif
  45   sim_events_install,
  46 #if WITH_WATCHPOINTS
  47   sim_watchpoint_install,
  48 #endif
  49 #if WITH_SCACHE
  50   scache_install,
  51 #endif
  52 #ifdef SIM_HAVE_MODEL /* FIXME: temporary */
  53   model_install,
  54 #endif
  55   /* Configured in [simulator specific] additional modules.  */
  56 #ifdef MODULE_LIST
  57   MODULE_LIST
  58 #endif
  59   0
  60 };
  61 \f
  62 /* Functions called from sim_open.  */
  63
  64 /* Initialize common parts before argument processing.  */
  65
  66 SIM_RC
  67 sim_pre_argv_init (SIM_DESC sd, const char *myname)
  68 {
  69   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
  70   STATE_MY_NAME (sd) = myname + strlen (myname);
  71   while (STATE_MY_NAME (sd) > myname && STATE_MY_NAME (sd)[-1] != '/')
  72     --STATE_MY_NAME (sd);
  73
  74   /* Install all configured in modules.  */
  75   if (sim_module_install (sd) != SIM_RC_OK)
  76     return SIM_RC_FAIL;
  77
  78   return SIM_RC_OK;
  79 }
  80
  81 /* Initialize common parts after argument processing.  */
  82
  83 SIM_RC
  84 sim_post_argv_init (SIM_DESC sd)
  85 {
  86   int i;
  87   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
  88
  89   if (sim_module_init (sd) != SIM_RC_OK)
  90     return SIM_RC_FAIL;
  91
  92   /* Set the cpu->state backlinks for each cpu.  */
  93   for (i = 0; i < MAX_NR_PROCESSORS; ++i)
  94     CPU_STATE (STATE_CPU (sd, i)) = sd;
  95
  96   return SIM_RC_OK;
  97 }
  98 \f
  99 /* Install all modules.  */
 100
 101 SIM_RC
 102 sim_module_install (SIM_DESC sd)
 103 {
 104   MODULE_INSTALL_FN * const *modp;
 105   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
 106
 107   for (modp = modules; *modp != NULL; ++modp)
 108     {
 109       if ((*modp) (sd) != SIM_RC_OK)
 110         return SIM_RC_FAIL;
 111     }
 112   return SIM_RC_OK;
 113 }
 114
 115 /* Called after all modules have been installed and after argv
 116    has been processed.  */
 117
 118 SIM_RC
 119 sim_module_init (SIM_DESC sd)
 120 {
 121   MODULE_INIT_LIST *modp;
 122   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
 123
 124   for (modp = STATE_INIT_LIST (sd); modp != NULL; modp = modp->next)
 125     {
 126       if ((*modp->fn) (sd) != SIM_RC_OK)
 127         return SIM_RC_FAIL;
 128     }
 129   return SIM_RC_OK;
 130 }
 131
 132 /* Called when ever the simulator is resumed */
 133
 134 SIM_RC
 135 sim_module_resume (SIM_DESC sd)
 136 {
 137   MODULE_RESUME_LIST *modp;
 138   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
 139
 140   for (modp = STATE_RESUME_LIST (sd); modp != NULL; modp = modp->next)
 141     {
 142       if ((*modp->fn) (sd) != SIM_RC_OK)
 143         return SIM_RC_FAIL;
 144     }
 145   return SIM_RC_OK;
 146 }
 147
 148 /* Called when ever the simulator is suspended */
 149
 150 SIM_RC
 151 sim_module_suspend (SIM_DESC sd)
 152 {
 153   MODULE_SUSPEND_LIST *modp;
 154   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
 155
 156   for (modp = STATE_SUSPEND_LIST (sd); modp != NULL; modp = modp->next)
 157     {
 158       if ((*modp->fn) (sd) != SIM_RC_OK)
 159         return SIM_RC_FAIL;
 160     }
 161   return SIM_RC_OK;
 162 }
 163
 164 /* Uninstall installed modules, called by sim_close.  */
 165
 166 void
 167 sim_module_uninstall (SIM_DESC sd)
 168 {
 169   MODULE_UNINSTALL_LIST *modp;
 170   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
 171
 172   /* Uninstall the modules.  */
 173   for (modp = STATE_UNINSTALL_LIST (sd); modp != NULL; modp = modp->next)
 174     (*modp->fn) (sd);
 175 }
 176 \f
 177 /* Add FN to the init handler list.
 178    init in the same order as the install. */
 179
 180 void
 181 sim_module_add_init_fn (SIM_DESC sd, MODULE_INIT_FN fn)
 182 {
 183   MODULE_INIT_LIST *l =
 184     (MODULE_INIT_LIST *) xmalloc (sizeof (MODULE_INIT_LIST));
 185   MODULE_INIT_LIST **last = &STATE_INIT_LIST (sd);
 186   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
 187
 188   while (*last != NULL)
 189     last = &((*last)->next);
 190
 191   l->fn = fn;
 192   l->next = NULL;
 193   *last = l;
 194 }
 195
 196 /* Add FN to the resume handler list.
 197    resume in the same order as the install. */
 198
 199 void
 200 sim_module_add_resume_fn (SIM_DESC sd, MODULE_RESUME_FN fn)
 201 {
 202   MODULE_RESUME_LIST *l = ZALLOC (MODULE_RESUME_LIST);
 203   MODULE_RESUME_LIST **last;
 204   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
 205
 206   last = &STATE_RESUME_LIST (sd);
 207   while (*last != NULL)
 208     last = &((*last)->next);
 209
 210   l->fn = fn;
 211   l->next = NULL;
 212   *last = l;
 213 }
 214
 215 /* Add FN to the init handler list.
 216    suspend in the reverse order to install. */
 217
 218 void
 219 sim_module_add_suspend_fn (SIM_DESC sd, MODULE_SUSPEND_FN fn)
 220 {
 221   MODULE_SUSPEND_LIST *l = ZALLOC (MODULE_SUSPEND_LIST);
 222   MODULE_SUSPEND_LIST **last;
 223   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
 224
 225   last = &STATE_SUSPEND_LIST (sd);
 226   while (*last != NULL)
 227     last = &((*last)->next);
 228
 229   l->fn = fn;
 230   l->next = STATE_SUSPEND_LIST (sd);
 231   STATE_SUSPEND_LIST (sd) = l;
 232 }
 233
 234 /* Add FN to the uninstall handler list.
 235    Uninstall in reverse order to install.  */
 236
 237 void
 238 sim_module_add_uninstall_fn (SIM_DESC sd, MODULE_UNINSTALL_FN fn)
 239 {
 240   MODULE_UNINSTALL_LIST *l =
 241     (MODULE_UNINSTALL_LIST *) xmalloc (sizeof (MODULE_UNINSTALL_LIST));
 242
 243   l->fn = fn;
 244   l->next = STATE_UNINSTALL_LIST (sd);
 245   STATE_UNINSTALL_LIST (sd) = l;
 246 }