/*
 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * flit_d.hh
 *
 * Niket Agarwal, Princeton University
 *
 * */


#ifndef FLIT_D_H
#define FLIT_D_H

#include "mem/ruby/network/garnet-fixed-pipeline/NetworkHeader.hh"
#include "mem/ruby/slicc_interface/Message.hh"

class flit_d {
public:
        flit_d(int id, int vc, int vnet, int size, MsgPtr msg_ptr);
        flit_d(int vc, bool is_free_signal);
        void set_outport(int port) { m_outport = port; }
        int get_outport() {return m_outport; }
        void print(ostream& out) const;
        bool is_free_signal()
        {
                return m_is_free_signal;
        }

        inline int get_size()
        {
                return m_size;
        }
        inline Time get_enqueue_time()
        {
                return m_enqueue_time;
        }
        inline int get_id()
        {
                return m_id;
        }
        inline Time get_time()
        {
                return m_time;
        }
        inline void set_time(Time time)
        {
                m_time = time;
        }
        inline int get_vnet()
        {
                return m_vnet;
        }
        inline int get_vc()
        {
                return m_vc;
        }
        inline void set_vc(int vc)
        {
                m_vc = vc;
        }
        inline MsgPtr& get_msg_ptr()
        {
                return m_msg_ptr;
        }
        inline flit_type get_type()
        {
                return m_type;
        }
        inline bool is_stage(flit_stage t_stage)
        {
                return ((m_stage.first == t_stage) && (g_eventQueue_ptr->getTime() >= m_stage.second));
        }
        inline bool is_next_stage(flit_stage t_stage)
        {
                return ((m_stage.first == t_stage) && ((g_eventQueue_ptr->getTime()+1) >= m_stage.second));
        }
        inline void advance_stage(flit_stage t_stage)
        {
                m_stage.first = t_stage;
                m_stage.second = g_eventQueue_ptr->getTime() + 1;
        }
        inline pair<flit_stage, Time> get_stage()
        {
                return m_stage;
        }
        inline void set_delay(int delay)
        {
                src_delay = delay;
        }

        inline int get_delay()
        {
                return src_delay;
        }


private:
        /************Data Members*************/
        int m_id;
        int m_vnet;
        int m_vc;
        int m_size;
        bool m_is_free_signal;
        Time m_enqueue_time, m_time;
        flit_type m_type;
        MsgPtr m_msg_ptr;
        int m_outport;
        int src_delay;
        pair<flit_stage, Time> m_stage;

};

inline extern bool node_less_then_eq(flit_d* n1, flit_d* n2);

inline extern
bool node_less_then_eq(flit_d* n1, flit_d* n2)
{
  if (n1->get_time() == n2->get_time()) {
//    ASSERT(n1->flit_id != n2->flit_id);
    return (n1->get_id() <= n2->get_id());
  } else {
    return (n1->get_time() <= n2->get_time());
  }
}

// Output operator declaration
ostream& operator<<(ostream& out, const flit_d& obj);

// ******************* Definitions *******************

// Output operator definition
extern inline
ostream& operator<<(ostream& out, const flit_d& obj)
{
  obj.print(out);
  out << flush;
  return out;
}

#endif