PerfectSwitch.hh revision 8608:02d7ac5fb855 
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
46class MessageBuffer;
47class NetDest;
48class SimpleNetwork;
49
50struct LinkOrder
51{
52    int m_link;
53    int m_value;
54};
55
56class PerfectSwitch : public Consumer
57{
58  public:
59    PerfectSwitch(SwitchID sid, SimpleNetwork* network_ptr);
60    ~PerfectSwitch();
61
62    std::string name()
63    { return csprintf("PerfectSwitch-%i", m_switch_id); }
64
65    void addInPort(const std::vector<MessageBuffer*>& in);
66    void addOutPort(const std::vector<MessageBuffer*>& out,
67        const NetDest& routing_table_entry);
68    void clearRoutingTables();
69    void clearBuffers();
70    void reconfigureOutPort(const NetDest& routing_table_entry);
71    int getInLinks() const { return m_in.size(); }
72    int getOutLinks() const { return m_out.size(); }
73
74    void wakeup();
75    void storeEventInfo(int info);
76
77    void printStats(std::ostream& out) const;
78    void clearStats();
79    void printConfig(std::ostream& out) const;
80
81    void print(std::ostream& out) const;
82
83  private:
84    // Private copy constructor and assignment operator
85    PerfectSwitch(const PerfectSwitch& obj);
86    PerfectSwitch& operator=(const PerfectSwitch& obj);
87
88    SwitchID m_switch_id;
89
90    // vector of queues from the components
91    std::vector<std::vector<MessageBuffer*> > m_in;
92    std::vector<std::vector<MessageBuffer*> > m_out;
93    std::vector<NetDest> m_routing_table;
94    std::vector<LinkOrder> m_link_order;
95    int m_virtual_networks;
96    int m_round_robin_start;
97    int m_wakeups_wo_switch;
98    SimpleNetwork* m_network_ptr;
99    std::vector<int> m_pending_message_count;
100};
101
102inline std::ostream&
103operator<<(std::ostream& out, const PerfectSwitch& obj)
104{
105    obj.print(out);
106    out << std::flush;
107    return out;
108}
109
110#endif // __MEM_RUBY_NETWORK_SIMPLE_PERFECTSWITCH_HH__
111