text: /*
   * Copyright (c) 2008 Princeton University
   * 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: Niket Agarwal
   */
  
  #ifndef __MEM_RUBY_NETWORK_GARNET_FLEXIBLE_PIPELINE_GARNET_NETWORK_HH__
  #define __MEM_RUBY_NETWORK_GARNET_FLEXIBLE_PIPELINE_GARNET_NETWORK_HH__
  
  #include <iostream>
  #include <vector>
  
  #include "mem/ruby/network/garnet/BaseGarnetNetwork.hh"
  #include "mem/ruby/network/garnet/NetworkHeader.hh"
  #include "mem/ruby/network/Network.hh"
  #include "params/GarnetNetwork.hh"
  
  class NetworkInterface;
  class MessageBuffer;
  class Router;
  class Topology;
  class NetDest;
  class NetworkLink;
  
  class GarnetNetwork : public BaseGarnetNetwork
  {
    public:
      typedef GarnetNetworkParams Params;
      GarnetNetwork(const Params *p);
  
      ~GarnetNetwork();
  
      void init();
  
      int getBufferSize() { return m_buffer_size; }
      int getNumPipeStages() {return m_number_of_pipe_stages; }
      int getNumNodes(){ return m_nodes; }
  
      void collateStats();
      void regStats();
      void print(std::ostream& out) const;
  
      // Methods used by Topology to setup the network
      void makeOutLink(SwitchID src, NodeID dest, BasicLink* link, 
                       LinkDirection direction, 
                       const NetDest& routing_table_entry);
      void makeInLink(NodeID src, SwitchID dest, BasicLink* link, 
                      LinkDirection direction, 
                      const NetDest& routing_table_entry);
      void makeInternalLink(SwitchID src, SwitchID dest, BasicLink* link,
                            LinkDirection direction, 
                            const NetDest& routing_table_entry);
  
      //! Function for performing a functional read. The return value
      //! indicates if a message was found that had the required address.
      bool functionalRead(Packet *pkt);
  
      //! Function for performing a functional write. The return value
      //! indicates the number of messages that were written.
      uint32_t functionalWrite(Packet *pkt);
  
    private:
      void checkNetworkAllocation(NodeID id, bool ordered, int network_num,
                                  std::string vnet_type);
  
      GarnetNetwork(const GarnetNetwork& obj);
      GarnetNetwork& operator=(const GarnetNetwork& obj);
  
      std::vector<Router *> m_routers;   // All Routers in Network
      std::vector<NetworkLink *> m_links; // All links in network
      std::vector<NetworkInterface *> m_nis; // All NI's in Network
  
      int m_buffer_size;
      int m_number_of_pipe_stages;
  
      // Statistical variables
      Stats::Scalar m_average_link_utilization;
      Stats::Vector m_average_vc_load;
  };
  
  inline std::ostream&
  operator<<(std::ostream& out, const GarnetNetwork& obj)
  {
      obj.print(out);
      out << std::flush;
      return out;
  }
  
  #endif // __MEM_RUBY_NETWORK_GARNET_FLEXIBLE_PIPELINE_GARNET_NETWORK_HH__
  