OutVcState.hh revision 11666 
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_OUTVC_STATE_HH__
35#define __MEM_RUBY_NETWORK_GARNET_OUTVC_STATE_HH__
36
37#include "mem/ruby/network/garnet2.0/CommonTypes.hh"
38#include "mem/ruby/network/garnet2.0/GarnetNetwork.hh"
39
40class OutVcState
41{
42  public:
43    OutVcState(int id, GarnetNetwork *network_ptr);
44
45    int get_credit_count()          { return m_credit_count; }
46    inline bool has_credit()       { return (m_credit_count > 0); }
47    void increment_credit();
48    void decrement_credit();
49
50    inline bool
51    isInState(VC_state_type state, Cycles request_time)
52    {
53        return ((m_vc_state == state) && (request_time >= m_time) );
54    }
55    inline void
56    setState(VC_state_type state, Cycles time)
57    {
58        m_vc_state = state;
59        m_time = time;
60    }
61
62  private:
63    int m_id ;
64    Cycles m_time;
65    VC_state_type m_vc_state;
66    int m_credit_count;
67    int m_max_credit_count;
68};
69
70#endif // __MEM_RUBY_NETWORK_GARNET_OUTVC_STATE_HH__
71