fc5bf6713f
Multi gem5 is an extension to gem5 to enable parallel simulation of a distributed system (e.g. simulation of a pool of machines connected by Ethernet links). A multi gem5 run consists of seperate gem5 processes running in parallel (potentially on different hosts/slots on a cluster). Each gem5 process executes the simulation of a component of the simulated distributed system (e.g. a multi-core board with an Ethernet NIC). The patch implements the "distributed" Ethernet link device (dev/src/multi_etherlink.[hh.cc]). This device will send/receive (simulated) Ethernet packets to/from peer gem5 processes. The interface to talk to the peer gem5 processes is defined in dev/src/multi_iface.hh and in tcp_iface.hh. There is also a central message server process (util/multi/tcp_server.[hh,cc]) which acts like an Ethernet switch and transfers messages among the gem5 peers. A multi gem5 simulations can be kicked off by the util/multi/gem5-multi.sh wrapper script. Checkpoints are supported by multi-gem5. The checkpoint must be initiated by a single gem5 process. E.g., the gem5 process with rank 0 can take a checkpoint from the bootscript just before it invokes 'mpirun' to launch an MPI test. The message server process will notify all the other peer gem5 processes and make them take a checkpoint, too (after completing a global synchronisation to ensure that there are no inflight messages among gem5).
235 lines
6.9 KiB
C++
235 lines
6.9 KiB
C++
/*
|
|
* Copyright (c) 2015 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.
|
|
*
|
|
* 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: Gabor Dozsa
|
|
*/
|
|
|
|
/* @file
|
|
* Device module for a full duplex ethernet link for multi gem5 simulations.
|
|
*
|
|
* See comments in dev/multi_iface.hh for a generic description of multi
|
|
* gem5 simulations.
|
|
*
|
|
* This class is meant to be a drop in replacement for the EtherLink class for
|
|
* multi gem5 runs.
|
|
*
|
|
*/
|
|
#ifndef __DEV_MULTIETHERLINK_HH__
|
|
#define __DEV_MULTIETHERLINK_HH__
|
|
|
|
#include <iostream>
|
|
|
|
#include "dev/etherlink.hh"
|
|
#include "params/MultiEtherLink.hh"
|
|
|
|
class MultiIface;
|
|
class EthPacketData;
|
|
|
|
/**
|
|
* Model for a fixed bandwidth full duplex ethernet link.
|
|
*/
|
|
class MultiEtherLink : public EtherObject
|
|
{
|
|
protected:
|
|
class LocalIface;
|
|
|
|
/**
|
|
* Model base class for a single uni-directional link.
|
|
*
|
|
* The link will encapsulate and transfer Ethernet packets to/from
|
|
* the message server.
|
|
*/
|
|
class Link
|
|
{
|
|
protected:
|
|
std::string objName;
|
|
MultiEtherLink *parent;
|
|
LocalIface *localIface;
|
|
EtherDump *dump;
|
|
MultiIface *multiIface;
|
|
Event *event;
|
|
EthPacketPtr packet;
|
|
|
|
public:
|
|
Link(const std::string &name, MultiEtherLink *p,
|
|
EtherDump *d, Event *e) :
|
|
objName(name), parent(p), localIface(nullptr), dump(d),
|
|
multiIface(nullptr), event(e) {}
|
|
|
|
~Link() {}
|
|
|
|
const std::string name() const { return objName; }
|
|
bool busy() const { return (bool)packet; }
|
|
void setLocalInt(LocalIface *i) { assert(!localIface); localIface=i; }
|
|
|
|
void serialize(const std::string &base, CheckpointOut &cp) const;
|
|
void unserialize(const std::string &base, CheckpointIn &cp);
|
|
};
|
|
|
|
/**
|
|
* Model for a send link.
|
|
*/
|
|
class TxLink : public Link
|
|
{
|
|
protected:
|
|
/**
|
|
* Per byte send delay
|
|
*/
|
|
double ticksPerByte;
|
|
/**
|
|
* Random component of the send delay
|
|
*/
|
|
Tick delayVar;
|
|
|
|
/**
|
|
* Send done callback. Called from doneEvent.
|
|
*/
|
|
void txDone();
|
|
typedef EventWrapper<TxLink, &TxLink::txDone> DoneEvent;
|
|
friend void DoneEvent::process();
|
|
DoneEvent doneEvent;
|
|
|
|
public:
|
|
TxLink(const std::string &name, MultiEtherLink *p,
|
|
double invBW, Tick delay_var, EtherDump *d) :
|
|
Link(name, p, d, &doneEvent), ticksPerByte(invBW),
|
|
delayVar(delay_var), doneEvent(this) {}
|
|
~TxLink() {}
|
|
|
|
/**
|
|
* Register the multi interface to be used to talk to the
|
|
* peer gem5 processes.
|
|
*/
|
|
void setMultiInt(MultiIface *m) { assert(!multiIface); multiIface=m; }
|
|
|
|
/**
|
|
* Initiate sending of a packet via this link.
|
|
*
|
|
* @param packet Ethernet packet to send
|
|
*/
|
|
bool transmit(EthPacketPtr packet);
|
|
};
|
|
|
|
/**
|
|
* Model for a receive link.
|
|
*/
|
|
class RxLink : public Link
|
|
{
|
|
protected:
|
|
|
|
/**
|
|
* Transmission delay for the simulated Ethernet link.
|
|
*/
|
|
Tick linkDelay;
|
|
|
|
/**
|
|
* Receive done callback method. Called from doneEvent.
|
|
*/
|
|
void rxDone() ;
|
|
typedef EventWrapper<RxLink, &RxLink::rxDone> DoneEvent;
|
|
friend void DoneEvent::process();
|
|
DoneEvent doneEvent;
|
|
|
|
public:
|
|
|
|
RxLink(const std::string &name, MultiEtherLink *p,
|
|
Tick delay, EtherDump *d) :
|
|
Link(name, p, d, &doneEvent),
|
|
linkDelay(delay), doneEvent(this) {}
|
|
~RxLink() {}
|
|
|
|
/**
|
|
* Register our multi interface to talk to the peer gem5 processes.
|
|
*/
|
|
void setMultiInt(MultiIface *m);
|
|
};
|
|
|
|
/**
|
|
* Interface to the local simulated system
|
|
*/
|
|
class LocalIface : public EtherInt
|
|
{
|
|
private:
|
|
TxLink *txLink;
|
|
|
|
public:
|
|
LocalIface(const std::string &name, TxLink *tx, RxLink *rx,
|
|
MultiIface *m);
|
|
|
|
bool recvPacket(EthPacketPtr pkt) { return txLink->transmit(pkt); }
|
|
void sendDone() { peer->sendDone(); }
|
|
bool isBusy() { return txLink->busy(); }
|
|
};
|
|
|
|
|
|
protected:
|
|
/**
|
|
* Interface to talk to the peer gem5 processes.
|
|
*/
|
|
MultiIface *multiIface;
|
|
/**
|
|
* Send link
|
|
*/
|
|
TxLink *txLink;
|
|
/**
|
|
* Receive link
|
|
*/
|
|
RxLink *rxLink;
|
|
LocalIface *localIface;
|
|
|
|
public:
|
|
typedef MultiEtherLinkParams Params;
|
|
MultiEtherLink(const Params *p);
|
|
~MultiEtherLink();
|
|
|
|
const Params *
|
|
params() const
|
|
{
|
|
return dynamic_cast<const Params *>(_params);
|
|
}
|
|
|
|
virtual EtherInt *getEthPort(const std::string &if_name,
|
|
int idx) M5_ATTR_OVERRIDE;
|
|
|
|
void memWriteback() M5_ATTR_OVERRIDE;
|
|
void init() M5_ATTR_OVERRIDE;
|
|
void startup() M5_ATTR_OVERRIDE;
|
|
|
|
void serialize(CheckpointOut &cp) const M5_ATTR_OVERRIDE;
|
|
void unserialize(CheckpointIn &cp) M5_ATTR_OVERRIDE;
|
|
};
|
|
|
|
#endif // __DEV_MULTIETHERLINK_HH__
|