PerfectSwitch.hh revision 8229:78bf55f23338 
1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/*
30 * Perfect switch, of course it is perfect and no latency or what so
31 * ever. Every cycle it is woke up and perform all the necessary
32 * routings that must be done. Note, this switch also has number of
33 * input ports/output ports and has a routing table as well.
34 */
35
36#ifndef __MEM_RUBY_NETWORK_SIMPLE_PERFECTSWITCH_HH__
37#define __MEM_RUBY_NETWORK_SIMPLE_PERFECTSWITCH_HH__
38
39#include <iostream>
40#include <string>
41#include <vector>
42
43#include "mem/ruby/common/Consumer.hh"
44#include "mem/ruby/common/Global.hh"
45#include "mem/ruby/system/NodeID.hh"
46
47class MessageBuffer;
48class NetDest;
49class SimpleNetwork;
50
51struct LinkOrder
52{
53    int m_link;
54    int m_value;
55};
56
57class PerfectSwitch : public Consumer
58{
59  public:
60    PerfectSwitch(SwitchID sid, SimpleNetwork* network_ptr);
61    ~PerfectSwitch();
62
63    std::string name()
64    { return csprintf("PerfectSwitch-%i", m_switch_id); }
65
66    void addInPort(const std::vector<MessageBuffer*>& in);
67    void addOutPort(const std::vector<MessageBuffer*>& out,
68        const NetDest& routing_table_entry);
69    void clearRoutingTables();
70    void clearBuffers();
71    void reconfigureOutPort(const NetDest& routing_table_entry);
72    int getInLinks() const { return m_in.size(); }
73    int getOutLinks() const { return m_out.size(); }
74
75    void wakeup();
76    void storeEventInfo(int info);
77
78    void printStats(std::ostream& out) const;
79    void clearStats();
80    void printConfig(std::ostream& out) const;
81
82    void print(std::ostream& out) const;
83
84  private:
85    // Private copy constructor and assignment operator
86    PerfectSwitch(const PerfectSwitch& obj);
87    PerfectSwitch& operator=(const PerfectSwitch& obj);
88
89    SwitchID m_switch_id;
90
91    // vector of queues from the components
92    std::vector<std::vector<MessageBuffer*> > m_in;
93    std::vector<std::vector<MessageBuffer*> > m_out;
94    std::vector<NetDest> m_routing_table;
95    std::vector<LinkOrder> m_link_order;
96    int m_virtual_networks;
97    int m_round_robin_start;
98    int m_wakeups_wo_switch;
99    SimpleNetwork* m_network_ptr;
100    std::vector<int> m_pending_message_count;
101};
102
103inline std::ostream&
104operator<<(std::ostream& out, const PerfectSwitch& obj)
105{
106    obj.print(out);
107    out << std::flush;
108    return out;
109}
110
111#endif // __MEM_RUBY_NETWORK_SIMPLE_PERFECTSWITCH_HH__
112