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