flitBuffer.hh revision 11666:10d59d546ea2 
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_GARNET_FLIT_BUFFER_HH__
35#define __MEM_RUBY_NETWORK_GARNET_FLIT_BUFFER_HH__
36
37#include <algorithm>
38#include <iostream>
39#include <vector>
40
41#include "mem/ruby/network/garnet2.0/CommonTypes.hh"
42#include "mem/ruby/network/garnet2.0/flit.hh"
43
44class flitBuffer
45{
46  public:
47    flitBuffer();
48    flitBuffer(int maximum_size);
49
50    bool isReady(Cycles curTime);
51    bool isEmpty();
52    void print(std::ostream& out) const;
53    bool isFull();
54    void setMaxSize(int maximum);
55
56    flit *
57    getTopFlit()
58    {
59        flit *f = m_buffer.front();
60        std::pop_heap(m_buffer.begin(), m_buffer.end(), flit::greater);
61        m_buffer.pop_back();
62        return f;
63    }
64
65    flit *
66    peekTopFlit()
67    {
68        return m_buffer.front();
69    }
70
71    void
72    insert(flit *flt)
73    {
74        m_buffer.push_back(flt);
75        std::push_heap(m_buffer.begin(), m_buffer.end(), flit::greater);
76    }
77
78    uint32_t functionalWrite(Packet *pkt);
79
80  private:
81    std::vector<flit *> m_buffer;
82    int max_size;
83};
84
85inline std::ostream&
86operator<<(std::ostream& out, const flitBuffer& obj)
87{
88    obj.print(out);
89    out << std::flush;
90    return out;
91}
92
93#endif // __MEM_RUBY_NETWORK_GARNET_FLIT_BUFFER_HH__
94