/*
 * 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 GARNETNETWORK_D_H
#define GARNETNETWORK_D_H

#include "mem/ruby/network/garnet/NetworkHeader.hh"
#include "mem/gems_common/Vector.hh"
#include "mem/ruby/network/garnet/BaseGarnetNetwork.hh"
#include "mem/ruby/network/Network.hh"
#include "params/GarnetNetwork_d.hh"

class NetworkInterface_d;
class MessageBuffer;
class Router_d;
class Topology;
class NetDest;
class NetworkLink_d;
class CreditLink_d;

class GarnetNetwork_d : public BaseGarnetNetwork {
public:
    typedef GarnetNetwork_dParams Params;
    GarnetNetwork_d(const Params *p);

        ~GarnetNetwork_d();

        void init();

        int getNumNodes(){ return m_nodes;}

        // returns the queue requested for the given component
        MessageBuffer* getToNetQueue(NodeID id, bool ordered, int network_num);
        MessageBuffer* getFromNetQueue(NodeID id, bool ordered, int network_num);

        void clearStats();
        void printStats(ostream& out) const;
        void printConfig(ostream& out) const;
        void print(ostream& out) const;

        inline void increment_injected_flits()
        {
                m_flits_injected++;
        }
        inline void increment_recieved_flits()
        {
                m_flits_recieved++;
        }
        inline void increment_network_latency(Time latency)
        {
                m_network_latency += latency;
        }
        inline void increment_queueing_latency(Time latency)
        {
                m_queueing_latency += latency;
        }

        bool isVNetOrdered(int vnet)
        {
                return m_ordered[vnet];
        }
        bool validVirtualNetwork(int vnet) { return m_in_use[vnet]; }

        Time getRubyStartTime();

        void reset();

        // Methods used by Topology to setup the network
        void makeOutLink(SwitchID src, NodeID dest, const NetDest& routing_table_entry, int link_latency, int link_weight,  int bw_multiplier, bool isReconfiguration);
        void makeInLink(SwitchID src, NodeID dest, const NetDest& routing_table_entry, int link_latency, int bw_multiplier, bool isReconfiguration);
        void makeInternalLink(SwitchID src, NodeID dest, const NetDest& routing_table_entry, int link_latency, int link_weight, int bw_multiplier, bool isReconfiguration);

private:
        void checkNetworkAllocation(NodeID id, bool ordered, int network_num);

// Private copy constructor and assignment operator
        GarnetNetwork_d(const GarnetNetwork_d& obj);
        GarnetNetwork_d& operator=(const GarnetNetwork_d& obj);

/***********Data Members*************/
//      int m_virtual_networks;
//      int m_nodes;
        int m_flits_recieved, m_flits_injected;
        double m_network_latency, m_queueing_latency;

        Vector<bool> m_in_use;
        Vector<bool> m_ordered;

        Vector<Vector<MessageBuffer*> > m_toNetQueues;
        Vector<Vector<MessageBuffer*> > m_fromNetQueues;

        Vector<Router_d *> m_router_ptr_vector;   // All Routers in Network
        Vector<NetworkLink_d *> m_link_ptr_vector; // All links in the network
        Vector<CreditLink_d *> m_creditlink_ptr_vector; // All links in the network
        Vector<NetworkInterface_d *> m_ni_ptr_vector;   // All NI's in Network

//      Topology* m_topology_ptr;
        Time m_ruby_start;
};

// Output operator declaration
ostream& operator<<(ostream& out, const GarnetNetwork_d& obj);

// ******************* Definitions *******************
// Output operator definition
extern inline
ostream& operator<<(ostream& out, const GarnetNetwork_d& obj)
{
        obj.print(out);
        out << flush;
        return out;
}

#endif //GARNETNETWORK_D_H