blob: d18caaee5cacd4237d7141ece75bdc035cd2e779 [file] [log] [blame]
/*
* Copyright (c) 2020 Advanced Micro Devices, Inc.
* Copyright (c) 2008 Princeton University
* Copyright (c) 2016 Georgia Institute of Technology
* 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.
*/
#ifndef __MEM_RUBY_NETWORK_GARNET_0_GARNETNETWORK_HH__
#define __MEM_RUBY_NETWORK_GARNET_0_GARNETNETWORK_HH__
#include <iostream>
#include <vector>
#include "mem/ruby/network/Network.hh"
#include "mem/ruby/network/fault_model/FaultModel.hh"
#include "mem/ruby/network/garnet/CommonTypes.hh"
#include "params/GarnetNetwork.hh"
namespace gem5
{
namespace ruby
{
class FaultModel;
class NetDest;
namespace garnet
{
class NetworkInterface;
class Router;
class NetworkLink;
class CreditLink;
class GarnetNetwork : public Network
{
public:
typedef GarnetNetworkParams Params;
GarnetNetwork(const Params &p);
~GarnetNetwork() = default;
void init();
const char *garnetVersion = "3.0";
// Configuration (set externally)
// for 2D topology
int getNumRows() const { return m_num_rows; }
int getNumCols() { return m_num_cols; }
// for network
uint32_t getNiFlitSize() const { return m_ni_flit_size; }
uint32_t getBuffersPerDataVC() { return m_buffers_per_data_vc; }
uint32_t getBuffersPerCtrlVC() { return m_buffers_per_ctrl_vc; }
int getRoutingAlgorithm() const { return m_routing_algorithm; }
bool isFaultModelEnabled() const { return m_enable_fault_model; }
FaultModel* fault_model;
// Internal configuration
bool isVNetOrdered(int vnet) const { return m_ordered[vnet]; }
VNET_type
get_vnet_type(int vnet)
{
return m_vnet_type[vnet];
}
int getNumRouters();
int get_router_id(int ni, int vnet);
// Methods used by Topology to setup the network
void makeExtOutLink(SwitchID src, NodeID dest, BasicLink* link,
std::vector<NetDest>& routing_table_entry);
void makeExtInLink(NodeID src, SwitchID dest, BasicLink* link,
std::vector<NetDest>& routing_table_entry);
void makeInternalLink(SwitchID src, SwitchID dest, BasicLink* link,
std::vector<NetDest>& routing_table_entry,
PortDirection src_outport_dirn,
PortDirection dest_inport_dirn);
//! Function for performing a functional write. The return value
//! indicates the number of messages that were written.
uint32_t functionalWrite(Packet *pkt);
// Stats
void collateStats();
void regStats();
void resetStats();
void print(std::ostream& out) const;
// increment counters
void increment_injected_packets(int vnet) { m_packets_injected[vnet]++; }
void increment_received_packets(int vnet) { m_packets_received[vnet]++; }
void
increment_packet_network_latency(Tick latency, int vnet)
{
m_packet_network_latency[vnet] += latency;
}
void
increment_packet_queueing_latency(Tick latency, int vnet)
{
m_packet_queueing_latency[vnet] += latency;
}
void increment_injected_flits(int vnet) { m_flits_injected[vnet]++; }
void increment_received_flits(int vnet) { m_flits_received[vnet]++; }
void
increment_flit_network_latency(Tick latency, int vnet)
{
m_flit_network_latency[vnet] += latency;
}
void
increment_flit_queueing_latency(Tick latency, int vnet)
{
m_flit_queueing_latency[vnet] += latency;
}
void
increment_total_hops(int hops)
{
m_total_hops += hops;
}
void update_traffic_distribution(RouteInfo route);
int getNextPacketID() { return m_next_packet_id++; }
protected:
// Configuration
int m_num_rows;
int m_num_cols;
uint32_t m_ni_flit_size;
uint32_t m_max_vcs_per_vnet;
uint32_t m_buffers_per_ctrl_vc;
uint32_t m_buffers_per_data_vc;
int m_routing_algorithm;
bool m_enable_fault_model;
// Statistical variables
statistics::Vector m_packets_received;
statistics::Vector m_packets_injected;
statistics::Vector m_packet_network_latency;
statistics::Vector m_packet_queueing_latency;
statistics::Formula m_avg_packet_vnet_latency;
statistics::Formula m_avg_packet_vqueue_latency;
statistics::Formula m_avg_packet_network_latency;
statistics::Formula m_avg_packet_queueing_latency;
statistics::Formula m_avg_packet_latency;
statistics::Vector m_flits_received;
statistics::Vector m_flits_injected;
statistics::Vector m_flit_network_latency;
statistics::Vector m_flit_queueing_latency;
statistics::Formula m_avg_flit_vnet_latency;
statistics::Formula m_avg_flit_vqueue_latency;
statistics::Formula m_avg_flit_network_latency;
statistics::Formula m_avg_flit_queueing_latency;
statistics::Formula m_avg_flit_latency;
statistics::Scalar m_total_ext_in_link_utilization;
statistics::Scalar m_total_ext_out_link_utilization;
statistics::Scalar m_total_int_link_utilization;
statistics::Scalar m_average_link_utilization;
statistics::Vector m_average_vc_load;
statistics::Scalar m_total_hops;
statistics::Formula m_avg_hops;
std::vector<std::vector<statistics::Scalar *>> m_data_traffic_distribution;
std::vector<std::vector<statistics::Scalar *>> m_ctrl_traffic_distribution;
private:
GarnetNetwork(const GarnetNetwork& obj);
GarnetNetwork& operator=(const GarnetNetwork& obj);
std::vector<VNET_type > m_vnet_type;
std::vector<Router *> m_routers; // All Routers in Network
std::vector<NetworkLink *> m_networklinks; // All flit links in the network
std::vector<CreditLink *> m_creditlinks; // All credit links in the network
std::vector<NetworkInterface *> m_nis; // All NI's in Network
int m_next_packet_id; // static vairable for packet id allocation
};
inline std::ostream&
operator<<(std::ostream& out, const GarnetNetwork& obj)
{
obj.print(out);
out << std::flush;
return out;
}
} // namespace garnet
} // namespace ruby
} // namespace gem5
#endif //__MEM_RUBY_NETWORK_GARNET_0_GARNETNETWORK_HH__