sim/common/hw-events.c

   1 /* Hardware event manager.
   2    Copyright (C) 1998 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
  22 #include "hw-main.h"
  23 #include "hw-base.h"
  24
  25 #include "sim-events.h"
  26
  27
  28 /* The hw-events object is implemented using sim-events */
  29
  30 struct hw_event {
  31   void *data;
  32   struct hw *me;
  33   hw_event_callback *callback;
  34   sim_event *real;
  35   struct hw_event_data *entry;
  36 };
  37
  38 struct hw_event_data {
  39   struct hw_event event;
  40   struct hw_event_data *next;
  41 };
  42
  43 void
  44 create_hw_event_data (struct hw *me)
  45 {
  46   if (me->events_of_hw != NULL)
  47     hw_abort (me, "stray events");
  48   /* NOP */
  49 }
  50
  51 void
  52 delete_hw_event_data (struct hw *me)
  53 {
  54   if (me->events_of_hw != NULL)
  55     hw_abort (me, "stray events");
  56 }
  57
  58
  59 /* Pass the H/W event onto the real callback */
  60
  61 static void
  62 bounce_hw_event (SIM_DESC sd,
  63                  void *data)
  64 {
  65   /* save the data */
  66   struct hw_event_data *entry = (struct hw_event_data *) data;
  67   struct hw *me = entry->event.me;
  68   void *event_data = entry->event.data;
  69   hw_event_callback *callback = entry->event.callback;
  70   struct hw_event_data **prev = &me->events_of_hw;
  71   while ((*prev) != entry)
  72     prev = &(*prev)->next;
  73   (*prev) = entry->next;
  74   hw_free (me, entry);
  75   callback (me, event_data); /* may not return */
  76 }
  77
  78
  79
  80 /* Map onto the event functions */
  81
  82 struct hw_event *
  83 hw_event_queue_schedule (struct hw *me,
  84                          signed64 delta_time,
  85                          hw_event_callback *callback,
  86                          void *data)
  87 {
  88   struct hw_event *event;
  89   va_list dummy;
  90   event = hw_event_queue_schedule_vtracef (me, delta_time, callback, data,
  91                                            NULL, dummy);
  92   return event;
  93 }
  94
  95 struct hw_event *
  96 hw_event_queue_schedule_tracef (struct hw *me,
  97                                 signed64 delta_time,
  98                                 hw_event_callback *callback,
  99                                 void *data,
 100                                 const char *fmt,
 101                                 ...)
 102 {
 103   struct hw_event *event;
 104   va_list ap;
 105   va_start (ap, fmt);
 106   event = hw_event_queue_schedule_vtracef (me, delta_time, callback, data, fmt, ap);
 107   va_end (ap);
 108   return event;
 109 }
 110
 111 struct hw_event *
 112 hw_event_queue_schedule_vtracef (struct hw *me,
 113                                  signed64 delta_time,
 114                                  hw_event_callback *callback,
 115                                  void *data,
 116                                  const char *fmt,
 117                                  va_list ap)
 118 {
 119   struct hw_event_data *entry = HW_ZALLOC (me, struct hw_event_data);
 120   entry->next = me->events_of_hw;
 121   me->events_of_hw = entry;
 122   /* fill it in */
 123   entry->event.entry = entry;
 124   entry->event.data = data;
 125   entry->event.callback = callback;
 126   entry->event.me = me;
 127   entry->event.real = sim_events_schedule_vtracef (hw_system (me),
 128                                                    delta_time,
 129                                                    bounce_hw_event,
 130                                                    entry,
 131                                                    fmt, ap);
 132   return &entry->event;
 133 }
 134
 135
 136 void
 137 hw_event_queue_deschedule (struct hw *me,
 138                            struct hw_event *event_to_remove)
 139 {
 140 /* ZAP the event but only if it is still in the event queue.  Note
 141    that event_to_remove is only de-referenced after its validity has
 142    been confirmed.  */
 143   struct hw_event_data **prev;
 144   for (prev = &me->events_of_hw;
 145        (*prev) != NULL;
 146        prev = &(*prev)->next)
 147     {
 148       struct hw_event_data *entry = (*prev);
 149       if (&entry->event == event_to_remove)
 150         {
 151           sim_events_deschedule (hw_system (me),
 152                                  entry->event.real);
 153           (*prev) = entry->next;
 154           hw_free (me, entry);
 155           return;
 156         }
 157     }
 158 }
 159
 160
 161 signed64
 162 hw_event_queue_time (struct hw *me)
 163 {
 164   return sim_events_time (hw_system (me));
 165 }
 166
 167 /* Returns the time that remains before the event is raised. */
 168 signed64
 169 hw_event_remain_time (struct hw *me, struct hw_event *event)
 170 {
 171   signed64 t;
 172
 173   t = sim_events_remain_time (hw_system (me), event->real);
 174   return t;
 175 }
 176
 177 /* Only worry about this compling on ANSI systems.
 178    Build with `make test-hw-events' in sim/<cpu> directory*/
 179
 180 #if defined (MAIN)
 181 #include "sim-main.h"
 182 #include <string.h>
 183 #include <stdio.h>
 184
 185 static void
 186 test_handler (struct hw *me,
 187               void *data)
 188 {
 189   int *n = data;
 190   if (*n != hw_event_queue_time (me))
 191     abort ();
 192   *n = -(*n);
 193 }
 194
 195 int
 196 main (int argc,
 197       char **argv)
 198 {
 199   host_callback *cb = ZALLOC (host_callback);
 200   struct sim_state *sd = sim_state_alloc (0, cb);
 201   struct hw *me = ZALLOC (struct hw);
 202   sim_pre_argv_init (sd, "test-hw-events");
 203   sim_post_argv_init (sd);
 204   me->system_of_hw = sd;
 205
 206   printf ("Create hw-event-data\n");
 207   {
 208     create_hw_alloc_data (me);
 209     create_hw_event_data (me);
 210     delete_hw_event_data (me);
 211     delete_hw_alloc_data (me);
 212   }
 213
 214   printf ("Create hw-events\n");
 215   {
 216     struct hw_event *a;
 217     struct hw_event *b;
 218     struct hw_event *c;
 219     struct hw_event *d;
 220     create_hw_alloc_data (me);
 221     create_hw_event_data (me);
 222     a = hw_event_queue_schedule (me, 0, NULL, NULL);
 223     b = hw_event_queue_schedule (me, 1, NULL, NULL);
 224     c = hw_event_queue_schedule (me, 2, NULL, NULL);
 225     d = hw_event_queue_schedule (me, 1, NULL, NULL);
 226     hw_event_queue_deschedule (me, c);
 227     hw_event_queue_deschedule (me, b);
 228     hw_event_queue_deschedule (me, a);
 229     hw_event_queue_deschedule (me, d);
 230     c = HW_ZALLOC (me, struct hw_event);
 231     hw_event_queue_deschedule (me, b); /* OOPS! */
 232     hw_free (me, c);
 233     delete_hw_event_data (me);
 234     delete_hw_alloc_data (me);
 235   }
 236
 237   printf ("Schedule hw-events\n");
 238   {
 239     struct hw_event **e;
 240     int *n;
 241     int i;
 242     int nr = 4;
 243     e = HW_NZALLOC (me, struct hw_event *, nr);
 244     n = HW_NZALLOC (me, int, nr);
 245     create_hw_alloc_data (me);
 246     create_hw_event_data (me);
 247     for (i = 0; i < nr; i++)
 248       {
 249         n[i] = i;
 250         e[i] = hw_event_queue_schedule (me, i, test_handler, &n[i]);
 251       }
 252     sim_events_preprocess (sd, 1, 1);
 253     for (i = 0; i < nr; i++)
 254       {
 255         if (sim_events_tick (sd))
 256           sim_events_process (sd);
 257       }
 258     for (i = 0; i < nr; i++)
 259       {
 260         if (n[i] != -i)
 261           abort ();
 262         hw_event_queue_deschedule (me, e[i]);
 263       }
 264     hw_free (me, n);
 265     hw_free (me, e);
 266     delete_hw_event_data (me);
 267     delete_hw_alloc_data (me);
 268   }
 269
 270   return 0;
 271 }
 272 #endif