SimpleNetwork.hh revision 8308 
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#ifndef __MEM_RUBY_NETWORK_SIMPLE_SIMPLENETWORK_HH__
30#define __MEM_RUBY_NETWORK_SIMPLE_SIMPLENETWORK_HH__
31
32#include <iostream>
33#include <vector>
34
35#include "mem/ruby/common/Global.hh"
36#include "mem/ruby/network/Network.hh"
37#include "mem/ruby/system/NodeID.hh"
38#include "params/SimpleNetwork.hh"
39#include "sim/sim_object.hh"
40
41class NetDest;
42class MessageBuffer;
43class Throttle;
44class Switch;
45class Topology;
46
47class SimpleNetwork : public Network
48{
49  public:
50    typedef SimpleNetworkParams Params;
51    SimpleNetwork(const Params *p);
52    ~SimpleNetwork();
53
54    void init();
55
56    int getBufferSize() { return m_buffer_size; }
57    int getEndpointBandwidth() { return m_endpoint_bandwidth; }
58    bool getAdaptiveRouting() {return m_adaptive_routing; }
59
60    void printStats(std::ostream& out) const;
61    void clearStats();
62    void printConfig(std::ostream& out) const;
63
64    void reset();
65
66    // returns the queue requested for the given component
67    MessageBuffer* getToNetQueue(NodeID id, bool ordered, int network_num, std::string vnet_type);
68    MessageBuffer* getFromNetQueue(NodeID id, bool ordered, int network_num, std::string vnet_type);
69    virtual const std::vector<Throttle*>* getThrottles(NodeID id) const;
70
71    bool isVNetOrdered(int vnet) { return m_ordered[vnet]; }
72    bool validVirtualNetwork(int vnet) { return m_in_use[vnet]; }
73
74    int getNumNodes() {return m_nodes; }
75
76    // Methods used by Topology to setup the network
77    void makeOutLink(SwitchID src, NodeID dest, BasicLink* link,
78                     LinkDirection direction,
79                     const NetDest& routing_table_entry,
80                     bool isReconfiguration);
81    void makeInLink(NodeID src, SwitchID dest, BasicLink* link,
82                    LinkDirection direction,
83                    const NetDest& routing_table_entry,
84                    bool isReconfiguration);
85    void makeInternalLink(SwitchID src, SwitchID dest, BasicLink* link,
86                          LinkDirection direction,
87                          const NetDest& routing_table_entry,
88                          bool isReconfiguration);
89
90    void print(std::ostream& out) const;
91
92  private:
93    void checkNetworkAllocation(NodeID id, bool ordered, int network_num);
94    void addLink(SwitchID src, SwitchID dest, int link_latency);
95    void makeLink(SwitchID src, SwitchID dest,
96        const NetDest& routing_table_entry, int link_latency);
97    SwitchID createSwitch();
98    void makeTopology();
99    void linkTopology();
100
101    // Private copy constructor and assignment operator
102    SimpleNetwork(const SimpleNetwork& obj);
103    SimpleNetwork& operator=(const SimpleNetwork& obj);
104
105    // vector of queues from the components
106    std::vector<std::vector<MessageBuffer*> > m_toNetQueues;
107    std::vector<std::vector<MessageBuffer*> > m_fromNetQueues;
108
109    std::vector<bool> m_in_use;
110    std::vector<bool> m_ordered;
111    std::vector<Switch*> m_switch_ptr_vector;
112    std::vector<MessageBuffer*> m_buffers_to_free;
113    std::vector<Switch*> m_endpoint_switches;
114
115    int m_buffer_size;
116    int m_endpoint_bandwidth;
117    bool m_adaptive_routing;
118};
119
120inline std::ostream&
121operator<<(std::ostream& out, const SimpleNetwork& obj)
122{
123    obj.print(out);
124    out << std::flush;
125    return out;
126}
127
128#endif // __MEM_RUBY_NETWORK_SIMPLE_SIMPLENETWORK_HH__
129