SimpleNetwork.hh revision 10303:71e0934af9f1 
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/network/Network.hh"
36#include "params/SimpleNetwork.hh"
37
38class NetDest;
39class MessageBuffer;
40class Throttle;
41class Switch;
42
43class SimpleNetwork : public Network
44{
45  public:
46    typedef SimpleNetworkParams Params;
47    SimpleNetwork(const Params *p);
48    ~SimpleNetwork();
49
50    void init();
51
52    int getBufferSize() { return m_buffer_size; }
53    int getEndpointBandwidth() { return m_endpoint_bandwidth; }
54    bool getAdaptiveRouting() {return m_adaptive_routing; }
55
56    void collateStats();
57    void regStats();
58
59    // returns the queue requested for the given component
60    MessageBuffer* getToNetQueue(NodeID id, bool ordered, int network_num, std::string vnet_type);
61    MessageBuffer* getFromNetQueue(NodeID id, bool ordered, int network_num, std::string vnet_type);
62
63    bool isVNetOrdered(int vnet) { return m_ordered[vnet]; }
64    bool validVirtualNetwork(int vnet) { return m_in_use[vnet]; }
65
66    // Methods used by Topology to setup the network
67    void makeOutLink(SwitchID src, NodeID dest, BasicLink* link,
68                     LinkDirection direction,
69                     const NetDest& routing_table_entry);
70    void makeInLink(NodeID src, SwitchID dest, BasicLink* link,
71                    LinkDirection direction,
72                    const NetDest& routing_table_entry);
73    void makeInternalLink(SwitchID src, SwitchID dest, BasicLink* link,
74                          LinkDirection direction,
75                          const NetDest& routing_table_entry);
76
77    void print(std::ostream& out) const;
78
79    bool functionalRead(Packet *pkt);
80    uint32_t functionalWrite(Packet *pkt);
81
82  private:
83    void checkNetworkAllocation(NodeID id, bool ordered, int network_num);
84    void addLink(SwitchID src, SwitchID dest, int link_latency);
85    void makeLink(SwitchID src, SwitchID dest,
86        const NetDest& routing_table_entry, int link_latency);
87    void makeTopology();
88
89    // Private copy constructor and assignment operator
90    SimpleNetwork(const SimpleNetwork& obj);
91    SimpleNetwork& operator=(const SimpleNetwork& obj);
92    std::vector<Switch*> m_switches;
93    std::vector<MessageBuffer*> m_buffers_to_free;
94    std::vector<Switch*> m_endpoint_switches;
95
96    int m_buffer_size;
97    int m_endpoint_bandwidth;
98    bool m_adaptive_routing;
99
100    //Statistical variables
101    Stats::Formula m_msg_counts[MessageSizeType_NUM];
102    Stats::Formula m_msg_bytes[MessageSizeType_NUM];
103};
104
105inline std::ostream&
106operator<<(std::ostream& out, const SimpleNetwork& obj)
107{
108    obj.print(out);
109    out << std::flush;
110    return out;
111}
112
113#endif // __MEM_RUBY_NETWORK_SIMPLE_SIMPLENETWORK_HH__
114