1/*
2 * Copyright (c) 2008 Princeton University
3 * Copyright (c) 2016 Georgia Institute of Technology
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Niket Agarwal
30 *          Tushar Krishna
31 */
32
33
34#ifndef __MEM_RUBY_NETWORK_GARNET2_0_SWITCHALLOCATOR_HH__
35#define __MEM_RUBY_NETWORK_GARNET2_0_SWITCHALLOCATOR_HH__
36
37#include <iostream>
38#include <vector>
39
40#include "mem/ruby/common/Consumer.hh"
41#include "mem/ruby/network/garnet2.0/CommonTypes.hh"
42
43class Router;
44class InputUnit;
45class OutputUnit;
46
47class SwitchAllocator : public Consumer
48{
49  public:
50    SwitchAllocator(Router *router);
51    void wakeup();
52    void init();
53    void clear_request_vector();
54    void check_for_wakeup();
55    int get_vnet (int invc);
56    void print(std::ostream& out) const {};
57    void arbitrate_inports();
58    void arbitrate_outports();
59    bool send_allowed(int inport, int invc, int outport, int outvc);
60    int vc_allocate(int outport, int inport, int invc);
61
62    inline double
63    get_input_arbiter_activity()
64    {
65        return m_input_arbiter_activity;
66    }
67    inline double
68    get_output_arbiter_activity()
69    {
70        return m_output_arbiter_activity;
71    }
72
73    void resetStats();
74
75  private:
76    int m_num_inports, m_num_outports;
77    int m_num_vcs, m_vc_per_vnet;
78
79    double m_input_arbiter_activity, m_output_arbiter_activity;
80
81    Router *m_router;
82    std::vector<int> m_round_robin_invc;
83    std::vector<int> m_round_robin_inport;
84    std::vector<std::vector<bool>> m_port_requests;
85    std::vector<std::vector<int>> m_vc_winners; // a list for each outport
86    std::vector<InputUnit *> m_input_unit;
87    std::vector<OutputUnit *> m_output_unit;
88};
89
90#endif // __MEM_RUBY_NETWORK_GARNET2_0_SWITCHALLOCATOR_HH__
91