gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Private Attributes | List of all members
TraceGen Class Reference

The trace replay generator reads a trace file and plays back the transactions. More...

#include <generators.hh>

Inheritance diagram for TraceGen:
BaseGen

Classes

class  InputStream
 The InputStream encapsulates a trace file and the internal buffers and populates TraceElements based on the input. More...
 
struct  TraceElement
 This struct stores a line in the trace file. More...
 

Public Member Functions

 TraceGen (const std::string &_name, MasterID master_id, Tick _duration, const std::string &trace_file, Addr addr_offset)
 Create a trace generator. More...
 
void enter ()
 Enter this generator state. More...
 
PacketPtr getNextPacket ()
 Get the next generated packet. More...
 
void exit ()
 Exit this generator state. More...
 
Tick nextPacketTick (bool elastic, Tick delay) const
 Returns the tick when the next request should be generated. More...
 
- Public Member Functions inherited from BaseGen
 BaseGen (const std::string &_name, MasterID master_id, Tick _duration)
 Create a base generator. More...
 
virtual ~BaseGen ()
 
std::string name () const
 Get the name, useful for DPRINTFs. More...
 

Private Attributes

InputStream trace
 Input stream used for reading the input trace file. More...
 
TraceElement currElement
 Store the current and next element in the trace. More...
 
TraceElement nextElement
 
Tick tickOffset
 Stores the time when the state was entered. More...
 
Addr addrOffset
 Offset for memory requests. More...
 
bool traceComplete
 Set to true when the trace replay for one instance of state is complete. More...
 

Additional Inherited Members

- Public Attributes inherited from BaseGen
const Tick duration
 Time to spend in this state. More...
 
- Protected Member Functions inherited from BaseGen
PacketPtr getPacket (Addr addr, unsigned size, const MemCmd &cmd, Request::FlagsType flags=0)
 Generate a new request and associated packet. More...
 
- Protected Attributes inherited from BaseGen
const std::string _name
 Name to use for status and debug printing. More...
 
const MasterID masterID
 The MasterID used for generating requests. More...
 

Detailed Description

The trace replay generator reads a trace file and plays back the transactions.

The trace is offset with respect to the time when the state was entered.

Definition at line 497 of file generators.hh.

Constructor & Destructor Documentation

TraceGen::TraceGen ( const std::string &  _name,
MasterID  master_id,
Tick  _duration,
const std::string &  trace_file,
Addr  addr_offset 
)
inline

Create a trace generator.

Parameters
_nameName to use for status and debug
master_idMasterID set on each request
_durationduration of this state before transitioning
trace_fileFile to read the transactions from
addr_offsetPositive offset to add to trace address

Definition at line 595 of file generators.hh.

Member Function Documentation

void TraceGen::enter ( )
virtual

Enter this generator state.

Implements BaseGen.

Definition at line 479 of file generators.cc.

References TraceGen::TraceElement::clear(), currElement, curTick(), nextElement, TraceGen::InputStream::read(), tickOffset, trace, and traceComplete.

void TraceGen::exit ( )
virtual

Exit this generator state.

By default do nothing.

Reimplemented from BaseGen.

Definition at line 528 of file generators.cc.

References BaseGen::name(), TraceGen::InputStream::reset(), trace, traceComplete, and warn.

PacketPtr TraceGen::getNextPacket ( )
virtual
Tick TraceGen::nextPacketTick ( bool  elastic,
Tick  delay 
) const
virtual

Returns the tick when the next request should be generated.

If the end of the file has been reached, it returns MaxTick to indicate that there will be no more requests.

Implements BaseGen.

Definition at line 456 of file generators.cc.

References curTick(), DPRINTF, TraceGen::TraceElement::isValid(), MaxTick, nextElement, TraceGen::TraceElement::tick, tickOffset, and traceComplete.

Member Data Documentation

Addr TraceGen::addrOffset
private

Offset for memory requests.

Used to shift the trace away from the CPU address space.

Definition at line 638 of file generators.hh.

Referenced by getNextPacket().

TraceElement TraceGen::currElement
private

Store the current and next element in the trace.

Definition at line 624 of file generators.hh.

Referenced by enter(), and getNextPacket().

TraceElement TraceGen::nextElement
private

Definition at line 625 of file generators.hh.

Referenced by enter(), getNextPacket(), and nextPacketTick().

Tick TraceGen::tickOffset
mutableprivate

Stores the time when the state was entered.

This is to add an offset to the times stored in the trace file. This is mutable to allow us to change it as part of nextPacketTick.

Definition at line 632 of file generators.hh.

Referenced by enter(), getNextPacket(), and nextPacketTick().

InputStream TraceGen::trace
private

Input stream used for reading the input trace file.

Definition at line 621 of file generators.hh.

Referenced by enter(), exit(), getNextPacket(), TraceGen::InputStream::init(), TraceGen::InputStream::read(), and TraceGen::InputStream::reset().

bool TraceGen::traceComplete
private

Set to true when the trace replay for one instance of state is complete.

Definition at line 644 of file generators.hh.

Referenced by enter(), exit(), getNextPacket(), and nextPacketTick().


The documentation for this class was generated from the following files:

Generated on Fri Jun 9 2017 13:04:22 for gem5 by doxygen 1.8.6