Files
gem5/src/sim/eventq_impl.hh
Andreas Sandberg 5b3752c372 sim: Add hooks to implement event reference counting
We currently only support deleting an event if it is triggered and not
re-scheduled. This is fine for most native code. However, there are
cases where Python needs to count references to make sure that the
Python object stays live while the native object is live.

Generalise the mechanism used to implement by adding reference
counting hooks to the event base class:

  * Event::acquire() / Event::acquireImpl()
  * Event::release() / Event::releaseImpl()

These calls can be used to implement both reference counting and the
existing AutoDelete functionality. The default implementation in Event
maintains backwards compatibility with the existing AutoDelete feature
by ignoring acquireImpl() and deleting the event on releaseImpl() if
it isn't scheduled anymore.

Since AutoDelete functionality is no longer the only way events can be
managed, this change introduces the new Managed flag. This flag
activates automatic memory management. The acquireImpl()/releaseImpl()
methods are only called from acquire()/release() it is set. To
maintain backwards compatibility, AutoDelete is used as an alias for
Managed.

Change-Id: I5637984c906a9d44c22780712cf1c521b8297149
Signed-off-by: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-by: Curtis Dunham <curtis.dunham@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/3221
Reviewed-by: Jason Lowe-Power <jason@lowepower.com>
2017-05-24 14:28:45 +00:00

110 lines
3.6 KiB
C++

/*
* Copyright (c) 2012 The Regents of The University of Michigan
* Copyright (c) 2012-2013 Mark D. Hill and David A. Wood
* Copyright (c) 2013 Advanced Micro Devices, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met: redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer;
* redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution;
* neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Authors: Steve Reinhardt
* Nathan Binkert
* Nilay Vaish
*/
#ifndef __SIM_EVENTQ_IMPL_HH__
#define __SIM_EVENTQ_IMPL_HH__
#include "base/trace.hh"
#include "sim/eventq.hh"
inline void
EventQueue::schedule(Event *event, Tick when, bool global)
{
assert(when >= getCurTick());
assert(!event->scheduled());
assert(event->initialized());
event->setWhen(when, this);
// The check below is to make sure of two things
// a. a thread schedules local events on other queues through the asyncq
// b. a thread schedules global events on the asyncq, whether or not
// this event belongs to this eventq. This is required to maintain
// a total order amongst the global events. See global_event.{cc,hh}
// for more explanation.
if (inParallelMode && (this != curEventQueue() || global)) {
asyncInsert(event);
} else {
insert(event);
}
event->flags.set(Event::Scheduled);
event->acquire();
if (DTRACE(Event))
event->trace("scheduled");
}
inline void
EventQueue::deschedule(Event *event)
{
assert(event->scheduled());
assert(event->initialized());
assert(!inParallelMode || this == curEventQueue());
remove(event);
event->flags.clear(Event::Squashed);
event->flags.clear(Event::Scheduled);
if (DTRACE(Event))
event->trace("descheduled");
event->release();
}
inline void
EventQueue::reschedule(Event *event, Tick when, bool always)
{
assert(when >= getCurTick());
assert(always || event->scheduled());
assert(event->initialized());
assert(!inParallelMode || this == curEventQueue());
if (event->scheduled()) {
remove(event);
} else {
event->acquire();
}
event->setWhen(when, this);
insert(event);
event->flags.clear(Event::Squashed);
event->flags.set(Event::Scheduled);
if (DTRACE(Event))
event->trace("rescheduled");
}
#endif // __SIM_EVENTQ_IMPL_HH__