text: The trace cpu replays traces generated using the elastic trace probe attached to the O3 CPU model. More...
  #include <trace_cpu.hh>
  The trace cpu replays traces generated using the elastic trace probe attached to the O3 CPU model.
  The elastic trace is an execution trace with register data dependencies and ordering dependencies annotated to it. The trace cpu also replays a fixed timestamp fetch trace that is also generated by the elastic trace probe. This trace cpu model aims at achieving faster simulation compared to the detailed cpu model and good correlation when the same trace is used for playback on different memory sub-systems.
  The TraceCPU inherits from BaseCPU so some virtual methods need to be defined. It has two port subclasses inherited from RequestPort for instruction and data ports. It issues the memory requests deducing the timing from the trace and without performing real execution of micro-ops. As soon as the last dependency for an instruction is complete, its computational delay, also provided in the input trace is added. The dependency-free nodes are maintained in a list, called 'ReadyList', ordered by ready time. Instructions which depend on load stall until the responses for read requests are received thus achieving elastic replay. If the dependency is not found when adding a new node, it is assumed complete. Thus, if this node is found to be completely dependency-free its issue time is calculated and it is added to the ready list immediately. This is encapsulated in the subclass ElasticDataGen.
  If ready nodes are issued in an unconstrained way there can be more nodes outstanding which results in divergence in timing compared to the O3CPU. Therefore, the Trace CPU also models hardware resources. A sub-class to model hardware resources contains the maximum sizes of load buffer, store buffer and ROB. If resources are not available, the node is not issued. Such nodes that are pending issue are held in the 'depFreeQueue' structure.
  Modeling the ROB size in the Trace CPU as a resource limitation is arguably the most important parameter of all resources. The ROB occupancy is estimated using the newly added field 'robNum'. We need to use ROB number as sequence number is at times much higher due to squashing and trace replay is focused on correct path modeling.
  A map called 'inFlightNodes' is added to track nodes that are not only in the readyList but also load nodes that are executed (and thus removed from readyList) but are not complete. ReadyList handles what and when to execute next node while the inFlightNodes is used for resource modelling. The oldest ROB number is updated when any node occupies the ROB or when an entry in the ROB is released. The ROB occupancy is equal to the difference in the ROB number of the newly dependency-free node and the oldest ROB number in flight.
  If no node depends on a non load/store node then there is no reason to track it in the dependency graph. We filter out such nodes but count them and add a weight field to the subsequent node that we do include in the trace. The weight field is used to model ROB occupancy during replay.
  The depFreeQueue is chosen to be FIFO so that child nodes which are in program order get pushed into it in that order and thus issued in program order, like in the O3CPU. This is also why the dependents is made a sequential container, std::set to std::vector. We only check head of the depFreeQueue as nodes are issued in order and blocking on head models that better than looping the entire queue. An alternative choice would be to inspect top N pending nodes where N is the issue-width. This is left for future as the timing correlation looks good as it is.
  At the start of an execution event, first we attempt to issue such pending nodes by checking if appropriate resources have become available. If yes, we compute the execute tick with respect to the time then. Then we proceed to complete nodes from the readyList.
  When a read response is received, sometimes a dependency on it that was supposed to be released when it was issued is still not released. This occurs because the dependent gets added to the graph after the read was sent. So the check is made less strict and the dependency is marked complete on read response instead of insisting that it should have been removed on read sent.
  There is a check for requests spanning two cache lines as this condition triggers an assert fail in the L1 cache. If it does then truncate the size to access only until the end of that line and ignore the remainder. Strictly-ordered requests are skipped and the dependencies on such requests are handled by simply marking them complete immediately.
  A CountedExitEvent that contains a static int belonging to the Trace CPU class as a down counter is used to implement multi Trace CPU simulation exit.
  Definition at line 142 of file trace_cpu.hh.
  Definition at line 49 of file trace_cpu.cc.
  References schedIcacheNext().
  This is called when either generator finishes executing from the trace.
  Definition at line 188 of file trace_cpu.cc.
  References gem5::curTick(), enableEarlyExit, execCompleteEvent, gem5::exitSimLoop(), inform, gem5::Named::name(), oneTraceComplete, and gem5::EventManager::schedule().
  Referenced by schedDcacheNext(), and schedIcacheNext().
  When data cache port receives a response, this calls the dcache generator method handle to complete the load writeback.
  Definition at line 1172 of file trace_cpu.cc.
  References gem5::TraceCPU::ElasticDataGen::completeMemAccess(), dcacheGen, and DPRINTF.
  Referenced by gem5::TraceCPU::DcachePort::recvTimingResp().
  When data cache port receives a retry, schedule event dcacheNextEvent.
  Definition at line 1130 of file trace_cpu.cc.
  References gem5::curTick(), dcacheNextEvent, DPRINTF, and gem5::EventManager::schedule().
  Referenced by gem5::TraceCPU::DcachePort::recvReqRetry().
  Used to get a reference to the dcache port.
  Implements gem5::BaseCPU.
  Definition at line 1126 of file trace_cpu.hh.
  References dcachePort.
  Referenced by takeOverFrom().
  Used to get a reference to the icache port.
  Implements gem5::BaseCPU.
  Definition at line 1123 of file trace_cpu.hh.
  References icachePort.
  Referenced by takeOverFrom().
  When instruction cache port receives a retry, schedule event icacheNextEvent.
  Definition at line 1120 of file trace_cpu.cc.
  References gem5::curTick(), DPRINTF, icacheNextEvent, and gem5::EventManager::schedule().
  Referenced by gem5::TraceCPU::IcachePort::recvReqRetry().
  init() is called after all C++ SimObjects have been created and all ports are connected.
  Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.
  Reimplemented from gem5::BaseCPU.
  Definition at line 105 of file trace_cpu.cc.
  References gem5::TraceCPU::ElasticDataGen::adjustInitTraceOffset(), dataTraceFile, dcacheGen, dcacheNextEvent, DPRINTF, enableEarlyExit, execCompleteEvent, icacheGen, icacheNextEvent, inform, gem5::BaseCPU::init(), gem5::TraceCPU::FixedRetryGen::init(), gem5::TraceCPU::ElasticDataGen::init(), instTraceFile, gem5::Named::name(), numTraceCPUs, gem5::EventManager::schedule(), and traceOffset.
  This is the control flow that uses the functionality of the dcacheGen to replay the trace.
  It calls execute(). It checks if execution is complete and schedules an event to exit simulation accordingly.
  Definition at line 174 of file trace_cpu.cc.
  References gem5::BaseCPU::baseStats, checkAndSchedExitEvent(), gem5::Clocked::clockEdge(), gem5::Clocked::clockPeriod(), dcacheGen, DPRINTF, gem5::TraceCPU::ElasticDataGen::execute(), gem5::TraceCPU::ElasticDataGen::isExecComplete(), and gem5::BaseCPU::BaseCPUStats::numCycles.
  Schedule event dcacheNextEvent at the given tick.
  Definition at line 1140 of file trace_cpu.cc.
  References dcacheNextEvent, DPRINTF, gem5::TraceCPU::TraceStats::numSchedDcacheEvent, gem5::EventManager::reschedule(), gem5::EventManager::schedule(), gem5::Event::scheduled(), traceStats, and gem5::Event::when().
  Referenced by gem5::TraceCPU::ElasticDataGen::completeMemAccess(), and gem5::TraceCPU::ElasticDataGen::execute().
  This is the control flow that uses the functionality of the icacheGen to replay the trace.
  It calls tryNext(). If it returns true then next event is scheduled at curTick() plus delta. If it returns false then delta is ignored and control is brought back via recvRetry().
  Definition at line 148 of file trace_cpu.cc.
  References checkAndSchedExitEvent(), gem5::curTick(), DPRINTF, icacheGen, icacheNextEvent, gem5::TraceCPU::FixedRetryGen::isTraceComplete(), gem5::TraceCPU::TraceStats::numSchedIcacheEvent, gem5::EventManager::schedule(), gem5::TraceCPU::FixedRetryGen::tickDelta(), traceStats, and gem5::TraceCPU::FixedRetryGen::tryNext().
  Referenced by TraceCPU().
  Load the state of a CPU from the previous CPU object, invoked on all new CPUs that are about to be switched in.
  A CPU model implementing this method is expected to initialize its state from the old CPU and connect its memory (unless they are already connected) to the memories connected to the old CPU.
  Reimplemented from gem5::BaseCPU.
  Definition at line 97 of file trace_cpu.cc.
  References gem5::BaseCPU::getDataPort(), getDataPort(), gem5::BaseCPU::getInstPort(), getInstPort(), and gem5::Port::takeOverFrom().
  This is a pure virtual function in BaseCPU.
  As we don't know how many insts are in the trace but only know how how many micro-ops are we cannot count this stat.
  Implements gem5::BaseCPU.
  Definition at line 157 of file trace_cpu.hh.
  Return totalOps as the number of committed micro-ops plus the speculatively issued loads that are modelled in the TraceCPU replay.
  Implements gem5::BaseCPU.
  Definition at line 165 of file trace_cpu.hh.
  References gem5::TraceCPU::TraceStats::numOps, traceStats, and gem5::statistics::ScalarBase< Derived, Stor >::value().
  Definition at line 86 of file trace_cpu.cc.
  References inform, gem5::Named::name(), gem5::TraceCPU::TraceStats::numOps, progressMsgInterval, progressMsgThreshold, traceStats, and gem5::statistics::ScalarBase< Derived, Stor >::value().
  Referenced by gem5::TraceCPU::ElasticDataGen::completeMemAccess(), and gem5::TraceCPU::ElasticDataGen::execute().
  Implements gem5::BaseCPU.
  Definition at line 174 of file trace_cpu.hh.
  Requestor id for data read and write requests.
  Definition at line 316 of file trace_cpu.hh.
  Definition at line 319 of file trace_cpu.hh.
  Instance of ElasticDataGen to replay data read and write requests.
  Definition at line 1034 of file trace_cpu.hh.
  Referenced by dcacheRecvTimingResp(), init(), and schedDcacheNext().
  Event for the control flow method schedDcacheNext()
  Definition at line 1055 of file trace_cpu.hh.
  Referenced by dcacheRetryRecvd(), init(), and schedDcacheNextEvent().
  Port to connect to L1 data cache.
  Definition at line 310 of file trace_cpu.hh.
  Referenced by getDataPort().
  Exit when any one Trace CPU completes its execution.
  If this is configured true then the execCompleteEvent is not scheduled.
  Definition at line 1093 of file trace_cpu.hh.
  Referenced by checkAndSchedExitEvent(), and init().
  A CountedExitEvent which when serviced decrements the counter.
  A sim exit event is scheduled when the counter equals zero, that is all instances of Trace CPU have had their execCompleteEvent serviced.
  Definition at line 1087 of file trace_cpu.hh.
  Referenced by checkAndSchedExitEvent(), and init().
  Instance of FixedRetryGen to replay instruction read requests.
  Definition at line 1031 of file trace_cpu.hh.
  Referenced by init(), and schedIcacheNext().
  Event for the control flow method schedIcacheNext()
  Definition at line 1052 of file trace_cpu.hh.
  Referenced by icacheRetryRecvd(), init(), and schedIcacheNext().
  Port to connect to L1 instruction cache.
  Definition at line 307 of file trace_cpu.hh.
  Referenced by getInstPort().
  Requestor id for instruction read requests.
  Definition at line 313 of file trace_cpu.hh.
  File names for input instruction and data traces.
  Definition at line 319 of file trace_cpu.hh.
  Number of Trace CPUs in the system used as a shared variable and passed to the CountedExitEvent event used for counting down exit events.
  It is incremented in the constructor call so that the total is arrived at automatically.
  Definition at line 1080 of file trace_cpu.hh.
  Set to true when one of the generators finishes replaying its trace.
  Definition at line 1064 of file trace_cpu.hh.
  Referenced by checkAndSchedExitEvent().
  Interval of committed instructions specified by the user at which a progress info message is printed.
  Definition at line 1099 of file trace_cpu.hh.
  Referenced by updateNumOps().
  Definition at line 1106 of file trace_cpu.hh.
  Referenced by updateNumOps().
  This stores the time offset in the trace, which is taken away from the ready times of requests.
  This is specially useful because the time offset can be very large if the traces are generated from the middle of a program.
  Definition at line 1072 of file trace_cpu.hh.
  Referenced by schedDcacheNextEvent(), schedIcacheNext(), totalOps(), and updateNumOps().