src/mem/ruby/network/garnet2.0/OutVcState.hh

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