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

#include <iostream>

#include "mem/ruby/network/garnet/NetworkHeader.hh"
#include "mem/gems_common/Vector.hh"
#include "mem/ruby/network/garnet/fixed-pipeline/flit_d.hh"
#include "mem/ruby/common/NetDest.hh"
#include "mem/ruby/network/orion/power_router_init.hh"

class GarnetNetwork_d;
class NetworkLink_d;
class CreditLink_d;
class InputUnit_d;
class OutputUnit_d;
class RoutingUnit_d;
class VCallocator_d;
class SWallocator_d;
class Switch_d;

class Router_d {
public:
        Router_d(int id, GarnetNetwork_d *network_ptr);

        ~Router_d();

        void init();
        void addInPort(NetworkLink_d *link, CreditLink_d *credit_link);
        void addOutPort(NetworkLink_d *link, const NetDest& routing_table_entry, int link_weight, CreditLink_d *credit_link);
        int get_num_vcs() { return m_num_vcs; }
        int get_vc_per_vnet() {return m_vc_per_vnet; }
        int get_num_inports() { return m_input_unit.size(); }
        int get_num_outports() { return m_output_unit.size(); }
        void printConfig(std::ostream& out);
        int get_id() { return m_id; }
        GarnetNetwork_d* get_net_ptr() { return m_network_ptr; }

        Vector<InputUnit_d *>& get_inputUnit_ref() { return m_input_unit; }
        Vector<OutputUnit_d *>& get_outputUnit_ref() { return m_output_unit; }

        void update_sw_winner(int inport, flit_d *t_flit);
        void update_incredit(int in_port, int in_vc, int credit);
        void route_req(flit_d *t_flit, InputUnit_d* in_unit, int invc);
        void vcarb_req();
        void swarb_req();

        void power_router_initialize(power_router *router, power_router_info *info);
    double calculate_power();
    double calculate_offline_power(power_router*, power_router_info*);
        void calculate_performance_numbers();

private:
        int m_id;
        int m_virtual_networks, m_num_vcs, m_vc_per_vnet;
        GarnetNetwork_d *m_network_ptr;
        int m_flit_width;

        double buf_read_count, buf_write_count, crossbar_count, vc_local_arbit_count, vc_global_arbit_count, sw_local_arbit_count, sw_global_arbit_count;

        Vector<InputUnit_d *> m_input_unit;
        Vector<OutputUnit_d *> m_output_unit;
        RoutingUnit_d *m_routing_unit;
        VCallocator_d *m_vc_alloc;
        SWallocator_d *m_sw_alloc;
        Switch_d *m_switch;
};

#endif