Bobby R. Bruce has submitted this change. (
https://gem5-review.googlesource.com/c/public/gem5/+/28407 )
Change subject: misc,sim: Tagged API methods in sim/simobject.hh
......................................................................
misc,sim: Tagged API methods in sim/simobject.hh
Change-Id: I1d4f5b67828e3bef64d781831cec4b25d6fcb6b9
Issue-on: https://gem5.atlassian.net/browse/GEM5-172
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/28407
Tested-by: kokoro <[email protected]>
Reviewed-by: Bobby R. Bruce <[email protected]>
Maintainer: Bobby R. Bruce <[email protected]>
---
M src/doxygen/group_definitions.hh
M src/sim/sim_object.hh
2 files changed, 46 insertions(+), 2 deletions(-)
Approvals:
Bobby R. Bruce: Looks good to me, approved; Looks good to me, approved
kokoro: Regressions pass
diff --git a/src/doxygen/group_definitions.hh
b/src/doxygen/group_definitions.hh
index e6e39b7..40069e0 100644
--- a/src/doxygen/group_definitions.hh
+++ b/src/doxygen/group_definitions.hh
@@ -21,3 +21,9 @@
*
* These methods relate to the statistics I/O interface.
*/
+
+/**
+ * @defgroup api_simobject The SimObject API.
+ *
+ * These methods relate to the SimObject interface.
+ */
diff --git a/src/sim/sim_object.hh b/src/sim/sim_object.hh
index 05c1b3e..de89fbf 100644
--- a/src/sim/sim_object.hh
+++ b/src/sim/sim_object.hh
@@ -103,17 +103,29 @@
ProbeManager *probeManager;
protected:
- /** Cached copy of the object parameters. */
+ /**
+ * Cached copy of the object parameters.
+ *
+ * @ingroup api_simobject
+ */
const SimObjectParams *_params;
public:
typedef SimObjectParams Params;
+ /**
+ * @ingroup api_simobject
+ * @{
+ */
const Params *params() const { return _params; }
SimObject(const Params *_params);
+ /** @}*/ //end of the api_simobject group
virtual ~SimObject();
public:
+ /**
+ * @ingroup api_simobject
+ */
virtual const std::string name() const { return params()->name; }
/**
@@ -121,6 +133,8 @@
* all ports are connected. Initializations that are independent
* of unserialization but rely on a fully instantiated and
* connected SimObject graph should be done here.
+ *
+ * @ingroup api_simobject
*/
virtual void init();
@@ -134,6 +148,8 @@
* found.
*
* @param cp Checkpoint to restore the state from.
+ *
+ * @ingroup api_serialize
*/
virtual void loadState(CheckpointIn &cp);
@@ -141,21 +157,29 @@
* initState() is called on each SimObject when *not* restoring
* from a checkpoint. This provides a hook for state
* initializations that are only required for a "cold start".
+ *
+ * @ingroup api_serialize
*/
virtual void initState();
/**
* Register probe points for this object.
+ *
+ * @ingroup api_simobject
*/
virtual void regProbePoints();
/**
* Register probe listeners for this object.
+ *
+ * @ingroup api_simobject
*/
virtual void regProbeListeners();
/**
* Get the probe manager for this object.
+ *
+ * @ingroup api_simobject
*/
ProbeManager *getProbeManager();
@@ -167,6 +191,8 @@
* @param idx Index in the case of a VectorPort
*
* @return A reference to the given port
+ *
+ * @ingroup api_simobject
*/
virtual Port &getPort(const std::string &if_name,
PortID idx=InvalidPortID);
@@ -176,6 +202,8 @@
* All state is initialized (including unserialized state, if any,
* such as the curTick() value), so this is the appropriate place to
* schedule initial event(s) for objects that need them.
+ *
+ * @ingroup api_simobject
*/
virtual void startup();
@@ -192,6 +220,8 @@
* written all its dirty data back to memory. This method is
* typically used to prepare a system with caches for
* checkpointing.
+ *
+ * @ingroup api_simobject
*/
virtual void memWriteback() {};
@@ -205,6 +235,8 @@
*
* @warn This does <i>not</i> cause any dirty state to be written
* back to memory.
+ *
+ * @ingroup api_simobject
*/
virtual void memInvalidate() {};
@@ -226,6 +258,8 @@
* Find the SimObject with the given name and return a pointer to
* it. Primarily used for interactive debugging. Argument is
* char* rather than std::string to make it callable from gdb.
+ *
+ * @ingroup api_simobject
*/
static SimObject *find(const char *name);
};
@@ -241,7 +275,11 @@
public:
virtual ~SimObjectResolver() { }
- // Find a SimObject given a full path name
+ /**
+ * Find a SimObject given a full path name
+ *
+ * @ingroup api_serialize
+ */
virtual SimObject *resolveSimObject(const std::string &name) = 0;
};
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/28407
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: release-staging-v20.0.0.0
Gerrit-Change-Id: I1d4f5b67828e3bef64d781831cec4b25d6fcb6b9
Gerrit-Change-Number: 28407
Gerrit-PatchSet: 5
Gerrit-Owner: Bobby R. Bruce <[email protected]>
Gerrit-Reviewer: Alec Roelke <[email protected]>
Gerrit-Reviewer: Ali Saidi <[email protected]>
Gerrit-Reviewer: Anthony Gutierrez <[email protected]>
Gerrit-Reviewer: Bobby R. Bruce <[email protected]>
Gerrit-Reviewer: Bradford Beckmann <[email protected]>
Gerrit-Reviewer: Daniel Carvalho <[email protected]>
Gerrit-Reviewer: Gabe Black <[email protected]>
Gerrit-Reviewer: Giacomo Travaglini <[email protected]>
Gerrit-Reviewer: Jason Lowe-Power <[email protected]>
Gerrit-Reviewer: Matt Sinclair <[email protected]>
Gerrit-Reviewer: kokoro <[email protected]>
Gerrit-MessageType: merged
_______________________________________________
gem5-dev mailing list -- [email protected]
To unsubscribe send an email to [email protected]
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
