gem5  v21.1.0.2
sim_object.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, 2021 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Copyright (c) 2001-2005 The Regents of The University of Michigan
15  * Copyright (c) 2010 Advanced Micro Devices, Inc.
16  * All rights reserved.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions are
20  * met: redistributions of source code must retain the above copyright
21  * notice, this list of conditions and the following disclaimer;
22  * redistributions in binary form must reproduce the above copyright
23  * notice, this list of conditions and the following disclaimer in the
24  * documentation and/or other materials provided with the distribution;
25  * neither the name of the copyright holders nor the names of its
26  * contributors may be used to endorse or promote products derived from
27  * this software without specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40  */
41 
42 /* @file
43  * User Console Definitions
44  */
45 
46 #ifndef __SIM_OBJECT_HH__
47 #define __SIM_OBJECT_HH__
48 
49 #include <string>
50 #include <vector>
51 
52 #include "base/named.hh"
53 #include "base/stats/group.hh"
54 #include "params/SimObject.hh"
55 #include "sim/drain.hh"
56 #include "sim/eventq.hh"
57 #include "sim/port.hh"
58 #include "sim/serialize.hh"
59 
60 namespace gem5
61 {
62 
63 class EventManager;
64 class ProbeManager;
65 class SimObjectResolver;
66 
146 class SimObject : public EventManager, public Serializable, public Drainable,
147  public statistics::Group, public Named
148 {
149  private:
151 
154 
157 
160 
161  protected:
167  const SimObjectParams &_params;
168 
169  public:
170  typedef SimObjectParams Params;
176  const Params &params() const { return _params; }
177 
181  SimObject(const Params &p);
182 
183  virtual ~SimObject();
184 
185  public:
194  virtual void init();
195 
209  virtual void loadState(CheckpointIn &cp);
210 
218  virtual void initState();
219 
225  virtual void regProbePoints();
226 
232  virtual void regProbeListeners();
233 
245 
269  virtual Port &getPort(const std::string &if_name,
270  PortID idx=InvalidPortID);
271 
280  virtual void startup();
281 
286  DrainState drain() override { return DrainState::Drained; }
287 
298  virtual void memWriteback() {};
299 
313  virtual void memInvalidate() {};
314 
315  void serialize(CheckpointOut &cp) const override {};
316  void unserialize(CheckpointIn &cp) override {};
317 
330  static void serializeAll(const std::string &cpt_dir);
331 
332 #ifdef DEBUG
333  public:
334  bool doDebugBreak;
335  static void debugObjectBreak(const std::string &objs);
336 #endif
337 
345  static SimObject *find(const char *name);
346 
353  static void setSimObjectResolver(SimObjectResolver *resolver);
354 
362 };
363 
364 /* Add PARAMS(ClassName) to every descendant of SimObject that needs
365  * params.
366  *
367  * Strictly speaking, we need static_cast here, because the types are
368  * related by inheritance, but since the target type may be
369  * incomplete, the compiler does not know the relation.
370  */
371 #define PARAMS(type) \
372  using Params = type ## Params; \
373  const Params & \
374  params() const \
375  { \
376  return reinterpret_cast<const Params&>(_params); \
377  }
378 
386 {
387  public:
388  virtual ~SimObjectResolver() { }
389 
395  virtual SimObject *resolveSimObject(const std::string &name) = 0;
396 };
397 
398 #ifdef DEBUG
399 void debugObjectBreak(const char *objs);
400 #endif
401 
408 void objParamIn(CheckpointIn &cp, const std::string &name, SimObject * &param);
409 
410 void debug_serialize(const std::string &cpt_dir);
411 
412 } // namespace gem5
413 
414 #endif // __SIM_OBJECT_HH__
gem5::PortID
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:252
gem5::SimObject::getPort
virtual Port & getPort(const std::string &if_name, PortID idx=InvalidPortID)
Get a port with a given name and index.
Definition: sim_object.cc:126
gem5::SimObject::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: sim_object.hh:316
gem5::SimObject::initState
virtual void initState()
initState() is called on each SimObject when not restoring from a checkpoint.
Definition: sim_object.cc:94
gem5::SimObject::memInvalidate
virtual void memInvalidate()
Invalidate the contents of memory buffers.
Definition: sim_object.hh:313
gem5::SimObject::_objNameResolver
static SimObjectResolver * _objNameResolver
Helper to resolve an object given its name.
Definition: sim_object.hh:156
serialize.hh
group.hh
gem5::SimObject::serializeAll
static void serializeAll(const std::string &cpt_dir)
Create a checkpoint by serializing all SimObjects in the system.
Definition: sim_object.cc:135
gem5::SimObject::probeManager
ProbeManager * probeManager
Manager coordinates hooking up probe points with listeners.
Definition: sim_object.hh:159
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::SimObject::_params
const SimObjectParams & _params
Cached copy of the object parameters.
Definition: sim_object.hh:167
named.hh
gem5::SimObject::find
static SimObject * find(const char *name)
Find the SimObject with the given name and return a pointer to it.
Definition: sim_object.cc:176
gem5::SimObject::loadState
virtual void loadState(CheckpointIn &cp)
loadState() is called on each SimObject when restoring from a checkpoint.
Definition: sim_object.cc:81
gem5::SimObject::init
virtual void init()
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: sim_object.cc:76
std::vector
STL vector class.
Definition: stl.hh:37
gem5::InvalidPortID
const PortID InvalidPortID
Definition: types.hh:253
gem5::SimObject::getSimObjectResolver
static SimObjectResolver * getSimObjectResolver()
There is a single object name resolver, and it is only set when simulation is restoring from checkpoi...
Definition: sim_object.cc:198
gem5::SimObject::SimObjectList
std::vector< SimObject * > SimObjectList
Definition: sim_object.hh:150
gem5::Named
Interface for things with names.
Definition: named.hh:38
gem5::SimObject::simObjectList
static SimObjectList simObjectList
List of all instantiated simulation objects.
Definition: sim_object.hh:153
gem5::debug_serialize
void debug_serialize(const std::string &cpt_dir)
Definition: sim_object.cc:216
gem5::SimObject::Params
SimObjectParams Params
Definition: sim_object.hh:170
gem5::EventManager
Definition: eventq.hh:987
gem5::Serializable
Basic support for object serialization.
Definition: serialize.hh:169
gem5::DrainState
DrainState
Object drain/handover states.
Definition: drain.hh:74
gem5::SimObject::~SimObject
virtual ~SimObject()
Definition: sim_object.cc:70
gem5::SimObject::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: sim_object.hh:315
gem5::Named::name
virtual std::string name() const
Definition: named.hh:47
gem5::objParamIn
void objParamIn(CheckpointIn &cp, const std::string &name, SimObject *&param)
To avoid circular dependencies the unserialization of SimObjects must be implemented here.
Definition: sim_object.cc:205
gem5::SimObject::params
const Params & params() const
Definition: sim_object.hh:176
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::DrainState::Drained
@ Drained
Buffers drained, ready for serialization/handover.
port.hh
name
const std::string & name()
Definition: trace.cc:49
gem5::ProbeManager
ProbeManager is a conduit class that lives on each SimObject, and is used to match up probe listeners...
Definition: probe.hh:163
gem5::SimObjectResolver::~SimObjectResolver
virtual ~SimObjectResolver()
Definition: sim_object.hh:388
gem5::SimObject::getProbeManager
ProbeManager * getProbeManager()
Get the probe manager for this object.
Definition: sim_object.cc:120
gem5::SimObject::regProbeListeners
virtual void regProbeListeners()
Register probe listeners for this object.
Definition: sim_object.cc:115
gem5::SimObject::SimObject
SimObject(const Params &p)
Definition: sim_object.cc:58
gem5::Port
Ports are used to interface objects to each other.
Definition: port.hh:61
gem5::SimObject::startup
virtual void startup()
startup() is the final initialization call before simulation.
Definition: sim_object.cc:99
gem5::SimObjectResolver
Base class to wrap object resolving functionality.
Definition: sim_object.hh:385
gem5::Drainable
Interface for objects that might require draining before checkpointing.
Definition: drain.hh:234
gem5::statistics::Group
Statistics container.
Definition: group.hh:93
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5::SimObject::memWriteback
virtual void memWriteback()
Write back dirty buffers to memory using functional writes.
Definition: sim_object.hh:298
drain.hh
gem5::SimObject::regProbePoints
virtual void regProbePoints()
Register probe points for this object.
Definition: sim_object.cc:107
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::SimObjectResolver::resolveSimObject
virtual SimObject * resolveSimObject(const std::string &name)=0
Find a SimObject given a full path name.
gem5::SimObject::setSimObjectResolver
static void setSimObjectResolver(SimObjectResolver *resolver)
There is a single object name resolver, and it is only set when simulation is restoring from checkpoi...
Definition: sim_object.cc:191
gem5::SimObject::drain
DrainState drain() override
Provide a default implementation of the drain interface for objects that don't need draining.
Definition: sim_object.hh:286
eventq.hh

Generated on Tue Sep 21 2021 12:25:48 for gem5 by doxygen 1.8.17