NetworkLink.hh revision 12492:4e76959883a6 
1/*
2 * Copyright (c) 2008 Princeton University
3 * Copyright (c) 2016 Georgia Institute of Technology
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Niket Agarwal
30 *          Tushar Krishna
31 */
32
33
34#ifndef __MEM_RUBY_NETWORK_GARNET2_0_NETWORKLINK_HH__
35#define __MEM_RUBY_NETWORK_GARNET2_0_NETWORKLINK_HH__
36
37#include <iostream>
38#include <vector>
39
40#include "mem/ruby/common/Consumer.hh"
41#include "mem/ruby/network/garnet2.0/CommonTypes.hh"
42#include "mem/ruby/network/garnet2.0/flitBuffer.hh"
43#include "params/NetworkLink.hh"
44#include "sim/clocked_object.hh"
45
46class GarnetNetwork;
47
48class NetworkLink : public ClockedObject, public Consumer
49{
50  public:
51    typedef NetworkLinkParams Params;
52    NetworkLink(const Params *p);
53    ~NetworkLink();
54
55    void setLinkConsumer(Consumer *consumer);
56    void setSourceQueue(flitBuffer *srcQueue);
57    void setType(link_type type) { m_type = type; }
58    link_type getType() { return m_type; }
59    void print(std::ostream& out) const {}
60    int get_id() const { return m_id; }
61    void wakeup();
62
63    unsigned int getLinkUtilization() const { return m_link_utilized; }
64    const std::vector<unsigned int> & getVcLoad() const { return m_vc_load; }
65
66    inline bool isReady(Cycles curTime)
67    { return linkBuffer->isReady(curTime); }
68
69    inline flit* peekLink()       { return linkBuffer->peekTopFlit(); }
70    inline flit* consumeLink()    { return linkBuffer->getTopFlit(); }
71
72    uint32_t functionalWrite(Packet *);
73    void resetStats();
74
75  private:
76    const int m_id;
77    link_type m_type;
78    const Cycles m_latency;
79
80    flitBuffer *linkBuffer;
81    Consumer *link_consumer;
82    flitBuffer *link_srcQueue;
83
84    // Statistical variables
85    unsigned int m_link_utilized;
86    std::vector<unsigned int> m_vc_load;
87};
88
89#endif // __MEM_RUBY_NETWORK_GARNET2_0_NETWORKLINK_HH__
90