Gabriel B. has submitted this change. (
https://gem5-review.googlesource.com/c/public/gem5/+/67653?usp=email )
Change subject: sim: Define a new MemberEventWrapper event class
......................................................................
sim: Define a new MemberEventWrapper event class
This new event class simplifies the use of EventWrapper and aims at
superseeding it. EventWrapper has been redefined in terms of
MemberEventWrapper.
MemberEventWrapper makes use of the new type traits to simplify
template parameterization and encourage its use over SimpleEvent that
often wraps a lambda that merely calls a member function.
Change-Id: Ie59e4c51705b9c2b2faa27097678d7d85f5b99c6
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/67653
Reviewed-by: Jason Lowe-Power <power...@gmail.com>
Tested-by: kokoro <noreply+kok...@google.com>
Maintainer: Daniel Carvalho <oda...@yahoo.com.br>
Reviewed-by: Daniel Carvalho <oda...@yahoo.com.br>
---
M src/sim/eventq.hh
1 file changed, 51 insertions(+), 23 deletions(-)
Approvals:
Jason Lowe-Power: Looks good to me, approved
Daniel Carvalho: Looks good to me, but someone else must approve; Looks
good to me, approved
kokoro: Regressions pass
diff --git a/src/sim/eventq.hh b/src/sim/eventq.hh
index 62495bf..b46a25b 100644
--- a/src/sim/eventq.hh
+++ b/src/sim/eventq.hh
@@ -46,7 +46,9 @@
#include "base/debug.hh"
#include "base/flags.hh"
+#include "base/named.hh"
#include "base/trace.hh"
+#include "base/type_traits.hh"
#include "base/types.hh"
#include "base/uncontended_mutex.hh"
#include "debug/Event.hh"
@@ -1071,38 +1073,64 @@
void setCurTick(Tick newVal) { eventq->setCurTick(newVal); }
};
-template <class T, void (T::* F)()>
-class EventWrapper : public Event
+/**
+ * @brief Wrap a member function inside MemberEventWrapper to use it as an
+ * event callback. This wrapper should be prefered over
EventFunctionWrapper
+ * for better performance and type safety.
+ *
+ * Wrapping a function *process* member of a class *klass* can be done by
+ * adding a member variable of the following type:
+ * MemberEventWrapper<&klass::process>.
+ *
+ * It is required that klass::process takes no explicit argument and
returns no
+ * value as these could not be handled by the event scheduler.
+ *
+ * @tparam F Pointer to the member function wrapped in this event.
+ */
+template <auto F>
+class MemberEventWrapper final: public Event, public Named
{
- private:
- T *object;
+ using CLASS = MemberFunctionClass_t<F>;
+ static_assert(std::is_same_v<void, MemberFunctionReturn_t<F>>);
+ static_assert(std::is_same_v<MemberFunctionArgsTuple_t<F>,
std::tuple<>>);
- public:
- EventWrapper(T *obj, bool del = false, Priority p = Default_Pri)
- : Event(p), object(obj)
+public:
+ MemberEventWrapper(CLASS *object,
+ bool del = false,
+ Priority p = Default_Pri):
+ Event(p),
+ Named(object->name() + ".wrapped_event"),
+ mObject(object)
{
- if (del)
- setFlags(AutoDelete);
+ gem5_assert(mObject);
+ if (del) setFlags(AutoDelete);
}
- EventWrapper(T &obj, bool del = false, Priority p = Default_Pri)
- : Event(p), object(&obj)
- {
- if (del)
- setFlags(AutoDelete);
+ /**
+ * @brief Construct a new MemberEventWrapper object
+ *
+ * @param object instance of the object to call the wrapped member
func on
+ * @param del if true, flag this event as AutoDelete
+ * @param p priority of this event
+ */
+ MemberEventWrapper(CLASS &object,
+ bool del = false,
+ Priority p = Default_Pri):
+ MemberEventWrapper(&object, del, p)
+ {}
+
+ void process() override {
+ (mObject->*F)();
}
- void process() { (object->*F)(); }
-
- const std::string
- name() const
- {
- return object->name() + ".wrapped_event";
- }
-
- const char *description() const { return "EventWrapped"; }
+ const char *description() const override { return "EventWrapped"; }
+private:
+ CLASS *mObject;
};
+template <class T, void (T::* F)()>
+using EventWrapper = MemberEventWrapper<F>;
+
class EventFunctionWrapper : public Event
{
private:
--
To view, visit
https://gem5-review.googlesource.com/c/public/gem5/+/67653?usp=email
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: Ie59e4c51705b9c2b2faa27097678d7d85f5b99c6
Gerrit-Change-Number: 67653
Gerrit-PatchSet: 4
Gerrit-Owner: Gabriel B. <gabriel.bus...@arteris.com>
Gerrit-Reviewer: Daniel Carvalho <oda...@yahoo.com.br>
Gerrit-Reviewer: Gabriel B. <gabriel.bus...@arteris.com>
Gerrit-Reviewer: Jason Lowe-Power <ja...@lowepower.com>
Gerrit-Reviewer: Jason Lowe-Power <power...@gmail.com>
Gerrit-Reviewer: kokoro <noreply+kok...@google.com>
Gerrit-MessageType: merged
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
