/*
 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
 * 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.
 */

/*
 * NetworkLink.cc
 *
 * Niket Agarwal, Princeton University
 *
 * */

#include "mem/ruby/network/garnet-flexible-pipeline/NetworkLink.hh"
#include "mem/ruby/network/garnet-flexible-pipeline/NetworkConfig.hh"
#include "mem/ruby/network/garnet-flexible-pipeline/GarnetNetwork.hh"

NetworkLink::NetworkLink(int id, int latency, GarnetNetwork *net_ptr)
{
        m_id = id;
        linkBuffer = new flitBuffer();
        m_in_port = 0;
        m_out_port = 0;
        m_link_utilized = 0;
        m_net_ptr = net_ptr;
        m_latency = latency;
        int num_net = NUMBER_OF_VIRTUAL_NETWORKS;
        int num_vc = NetworkConfig::getVCsPerClass();
        m_vc_load.setSize(num_net*num_vc);

        for(int i = 0; i < num_net*num_vc; i++)
                m_vc_load[i] = 0;
}

NetworkLink::~NetworkLink()
{
        delete linkBuffer;
}

int NetworkLink::get_id()
{
        return m_id;
}

void NetworkLink::setLinkConsumer(FlexibleConsumer *consumer)
{
        link_consumer = consumer;
}

void NetworkLink::setSourceQueue(flitBuffer *srcQueue)
{
        link_srcQueue = srcQueue;
}

void NetworkLink::setSource(FlexibleConsumer *source)
{
        link_source = source;
}
void NetworkLink::request_vc_link(int vc, NetDest destination, Time request_time)
{
        link_consumer->request_vc(vc, m_in_port, destination, request_time);
}
bool NetworkLink::isBufferNotFull_link(int vc)
{
        return link_consumer->isBufferNotFull(vc, m_in_port);
}

void NetworkLink::grant_vc_link(int vc, Time grant_time)
{
        link_source->grant_vc(m_out_port, vc, grant_time);
}

void NetworkLink::release_vc_link(int vc, Time release_time)
{
        link_source->release_vc(m_out_port, vc, release_time);
}

Vector<int> NetworkLink::getVcLoad()
{
        return m_vc_load;
}

double NetworkLink::getLinkUtilization()
{
        Time m_ruby_start = m_net_ptr->getRubyStartTime();
        return (double(m_link_utilized)) / (double(g_eventQueue_ptr->getTime()-m_ruby_start));
}

bool NetworkLink::isReady()
{
        return linkBuffer->isReady();
}

void NetworkLink::setInPort(int port)
{
        m_in_port = port;
}

void NetworkLink::setOutPort(int port)
{
        m_out_port = port;
}

void NetworkLink::wakeup()
{
        if(link_srcQueue->isReady())
        {
                flit *t_flit = link_srcQueue->getTopFlit();
                t_flit->set_time(g_eventQueue_ptr->getTime() + m_latency);
                linkBuffer->insert(t_flit);
                g_eventQueue_ptr->scheduleEvent(link_consumer, m_latency);
                m_link_utilized++;
                m_vc_load[t_flit->get_vc()]++;
        }
}

flit* NetworkLink::peekLink()
{
        return linkBuffer->peekTopFlit();
}

flit* NetworkLink::consumeLink()
{
        return linkBuffer->getTopFlit();
}