f16c0a4a90
Draining is currently done by traversing the SimObject graph and calling drain()/drainResume() on the SimObjects. This is not ideal when non-SimObjects (e.g., ports) need draining since this means that SimObjects owning those objects need to be aware of this. This changeset moves the responsibility for finding objects that need draining from SimObjects and the Python-side of the simulator to the DrainManager. The DrainManager now maintains a set of all objects that need draining. To reduce the overhead in classes owning non-SimObjects that need draining, objects inheriting from Drainable now automatically register with the DrainManager. If such an object is destroyed, it is automatically unregistered. This means that drain() and drainResume() should never be called directly on a Drainable object. While implementing the new functionality, the DrainManager has now been made thread safe. In practice, this means that it takes a lock whenever it manipulates the set of Drainable objects since SimObjects in different threads may create Drainable objects dynamically. Similarly, the drain counter is now an atomic_uint, which ensures that it is manipulated correctly when objects signal that they are done draining. A nice side effect of these changes is that it makes the drain state changes stricter, which the simulation scripts can exploit to avoid redundant drains.
214 lines
6.9 KiB
C++
214 lines
6.9 KiB
C++
/*
|
|
* Copyright (c) 2012 ARM Limited
|
|
* All rights reserved
|
|
*
|
|
* The license below extends only to copyright in the software and shall
|
|
* not be construed as granting a license to any other intellectual
|
|
* property including but not limited to intellectual property relating
|
|
* to a hardware implementation of the functionality of the software
|
|
* licensed hereunder. You may use the software subject to the license
|
|
* terms below provided that you ensure that this notice is replicated
|
|
* unmodified and in its entirety in all distributions of the software,
|
|
* modified or unmodified, in source code or in binary form.
|
|
*
|
|
* Copyright (c) 2008 The Regents of The University of Michigan
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are
|
|
* met: redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer;
|
|
* redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution;
|
|
* neither the name of the copyright holders nor the names of its
|
|
* contributors may be used to endorse or promote products derived from
|
|
* this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* Authors: Ali Saidi
|
|
*/
|
|
|
|
/* @file
|
|
* Device model for Intel's I/O Acceleration Technology (I/OAT).
|
|
* A DMA asyncronous copy engine
|
|
*/
|
|
|
|
#ifndef __DEV_COPY_ENGINE_HH__
|
|
#define __DEV_COPY_ENGINE_HH__
|
|
|
|
#include <vector>
|
|
|
|
#include "base/cp_annotate.hh"
|
|
#include "base/statistics.hh"
|
|
#include "dev/copy_engine_defs.hh"
|
|
#include "dev/pcidev.hh"
|
|
#include "params/CopyEngine.hh"
|
|
#include "sim/drain.hh"
|
|
#include "sim/eventq.hh"
|
|
|
|
class CopyEngine : public PciDevice
|
|
{
|
|
class CopyEngineChannel : public Drainable, public Serializable
|
|
{
|
|
private:
|
|
DmaPort cePort;
|
|
CopyEngine *ce;
|
|
CopyEngineReg::ChanRegs cr;
|
|
int channelId;
|
|
CopyEngineReg::DmaDesc *curDmaDesc;
|
|
uint8_t *copyBuffer;
|
|
|
|
bool busy;
|
|
bool underReset;
|
|
bool refreshNext;
|
|
Addr lastDescriptorAddr;
|
|
Addr fetchAddress;
|
|
|
|
Tick latBeforeBegin;
|
|
Tick latAfterCompletion;
|
|
|
|
uint64_t completionDataReg;
|
|
|
|
enum ChannelState {
|
|
Idle,
|
|
AddressFetch,
|
|
DescriptorFetch,
|
|
DMARead,
|
|
DMAWrite,
|
|
CompletionWrite
|
|
};
|
|
|
|
ChannelState nextState;
|
|
|
|
DrainManager *drainManager;
|
|
public:
|
|
CopyEngineChannel(CopyEngine *_ce, int cid);
|
|
virtual ~CopyEngineChannel();
|
|
BaseMasterPort &getMasterPort();
|
|
|
|
std::string name() { assert(ce); return ce->name() + csprintf("-chan%d", channelId); }
|
|
virtual Tick read(PacketPtr pkt)
|
|
{ panic("CopyEngineChannel has no I/O access\n");}
|
|
virtual Tick write(PacketPtr pkt)
|
|
{ panic("CopyEngineChannel has no I/O access\n"); }
|
|
|
|
void channelRead(PacketPtr pkt, Addr daddr, int size);
|
|
void channelWrite(PacketPtr pkt, Addr daddr, int size);
|
|
|
|
unsigned int drain(DrainManager *drainManger);
|
|
void drainResume();
|
|
|
|
void serialize(CheckpointOut &cp) const M5_ATTR_OVERRIDE;
|
|
void unserialize(CheckpointIn &cp) M5_ATTR_OVERRIDE;
|
|
|
|
private:
|
|
void fetchDescriptor(Addr address);
|
|
void fetchDescComplete();
|
|
EventWrapper<CopyEngineChannel, &CopyEngineChannel::fetchDescComplete>
|
|
fetchCompleteEvent;
|
|
|
|
void fetchNextAddr(Addr address);
|
|
void fetchAddrComplete();
|
|
EventWrapper<CopyEngineChannel, &CopyEngineChannel::fetchAddrComplete>
|
|
addrCompleteEvent;
|
|
|
|
void readCopyBytes();
|
|
void readCopyBytesComplete();
|
|
EventWrapper<CopyEngineChannel, &CopyEngineChannel::readCopyBytesComplete>
|
|
readCompleteEvent;
|
|
|
|
void writeCopyBytes();
|
|
void writeCopyBytesComplete();
|
|
EventWrapper <CopyEngineChannel, &CopyEngineChannel::writeCopyBytesComplete>
|
|
writeCompleteEvent;
|
|
|
|
void writeCompletionStatus();
|
|
void writeStatusComplete();
|
|
EventWrapper <CopyEngineChannel, &CopyEngineChannel::writeStatusComplete>
|
|
statusCompleteEvent;
|
|
|
|
|
|
void continueProcessing();
|
|
void recvCommand();
|
|
bool inDrain();
|
|
void restartStateMachine();
|
|
inline void anBegin(const char *s)
|
|
{
|
|
CPA::cpa()->hwBegin(CPA::FL_NONE, ce->sys,
|
|
channelId, "CopyEngine", s);
|
|
}
|
|
|
|
inline void anWait()
|
|
{
|
|
CPA::cpa()->hwWe(CPA::FL_NONE, ce->sys,
|
|
channelId, "CopyEngine", "DMAUnusedDescQ", channelId);
|
|
}
|
|
|
|
inline void anDq()
|
|
{
|
|
CPA::cpa()->hwDq(CPA::FL_NONE, ce->sys,
|
|
channelId, "CopyEngine", "DMAUnusedDescQ", channelId);
|
|
}
|
|
|
|
inline void anPq()
|
|
{
|
|
CPA::cpa()->hwDq(CPA::FL_NONE, ce->sys,
|
|
channelId, "CopyEngine", "DMAUnusedDescQ", channelId);
|
|
}
|
|
|
|
inline void anQ(const char * s, uint64_t id, int size = 1)
|
|
{
|
|
CPA::cpa()->hwQ(CPA::FL_NONE, ce->sys, channelId,
|
|
"CopyEngine", s, id, NULL, size);
|
|
}
|
|
|
|
};
|
|
|
|
private:
|
|
|
|
Stats::Vector bytesCopied;
|
|
Stats::Vector copiesProcessed;
|
|
|
|
// device registers
|
|
CopyEngineReg::Regs regs;
|
|
|
|
// Array of channels each one with regs/dma port/etc
|
|
std::vector<CopyEngineChannel*> chan;
|
|
|
|
public:
|
|
typedef CopyEngineParams Params;
|
|
const Params *
|
|
params() const
|
|
{
|
|
return dynamic_cast<const Params *>(_params);
|
|
}
|
|
CopyEngine(const Params *params);
|
|
~CopyEngine();
|
|
|
|
void regStats();
|
|
|
|
virtual BaseMasterPort &getMasterPort(const std::string &if_name,
|
|
PortID idx = InvalidPortID);
|
|
|
|
virtual Tick read(PacketPtr pkt);
|
|
virtual Tick write(PacketPtr pkt);
|
|
|
|
void serialize(CheckpointOut &cp) const M5_ATTR_OVERRIDE;
|
|
void unserialize(CheckpointIn &cp) M5_ATTR_OVERRIDE;
|
|
};
|
|
|
|
#endif //__DEV_COPY_ENGINE_HH__
|
|
|