/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2007, 2008 University of Washington

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation;

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

#include "ns3/log.h"

#include "ns3/queue.h"

#include "ns3/simulator.h"

#include "ns3/mac48-address.h"

#include "ns3/llc-snap-header.h"

#include "ns3/error-model.h"

#include "ns3/trace-source-accessor.h"

#include "ns3/uinteger.h"

#include "ns3/pointer.h"

#include "point-to-point-net-device.h"

#include "point-to-point-channel.h"

#include "ppp-header.h"

NS_LOG_COMPONENT_DEFINE ("PointToPointNetDevice");

namespace ns3 {

NS_OBJECT_ENSURE_REGISTERED (PointToPointNetDevice);

TypeId 

PointToPointNetDevice::GetTypeId (void)

{

  static TypeId tid = TypeId ("ns3::PointToPointNetDevice")

    .SetParent<NetDevice> ()

    .AddConstructor<PointToPointNetDevice> ()

    .AddAttribute ("Address", 

                   "The MAC address of this device.",

                   Mac48AddressValue (Mac48Address ("ff:ff:ff:ff:ff:ff")),

                   MakeMac48AddressAccessor (&PointToPointNetDevice::m_address),

                   MakeMac48AddressChecker ())

    .AddAttribute ("FrameSize", 

                   "The maximum size of a packet sent over this device.",

                   UintegerValue (DEFAULT_FRAME_SIZE),

                   MakeUintegerAccessor (&PointToPointNetDevice::SetFrameSize,

                                         &PointToPointNetDevice::GetFrameSize),

                   MakeUintegerChecker<uint16_t> ())

    .AddAttribute ("DataRate", 

                   "The default data rate for point to point links",

                   DataRateValue (DataRate ("32768b/s")),

                   MakeDataRateAccessor (&PointToPointNetDevice::m_bps),

                   MakeDataRateChecker ())

    .AddAttribute ("ReceiveErrorModel", 

                   "The receiver error model used to simulate packet loss",

                   PointerValue (),

                   MakePointerAccessor (&PointToPointNetDevice::m_receiveErrorModel),

                   MakePointerChecker<ErrorModel> ())

    .AddAttribute ("InterframeGap", 

                   "The time to wait between packet (frame) transmissions",

                   TimeValue (Seconds (0.0)),

                   MakeTimeAccessor (&PointToPointNetDevice::m_tInterframeGap),

                   MakeTimeChecker ())

    //

    // Transmit queueing discipline for the device which includes its own set

    // of trace hooks.

    //

    .AddAttribute ("TxQueue", 

                   "A queue to use as the transmit queue in the device.",

                   PointerValue (),

                   MakePointerAccessor (&PointToPointNetDevice::m_queue),

                   MakePointerChecker<Queue> ())

    //

    // Trace sources at the "top" of the net device, where packets transition

    // to/from higher layers.

    //

    .AddTraceSource ("MacTx", 

                     "Trace source indicating a packet has arrived for transmission by this device",

                     MakeTraceSourceAccessor (&PointToPointNetDevice::m_macTxTrace))

    .AddTraceSource ("MacTxDrop", 

                     "Trace source indicating a packet has been dropped by the device before transmission",

                     MakeTraceSourceAccessor (&PointToPointNetDevice::m_macTxDropTrace))

    .AddTraceSource ("MacRx", 

                     "Trace source indicating a packet has been received by this device and is being forwarded up the stack",

                     MakeTraceSourceAccessor (&PointToPointNetDevice::m_macRxTrace))

    //

    // Trace souces at the "bottom" of the net device, where packets transition

    // to/from the channel.

    //

                     "Trace source indicating a packet has begun transmitting over the channel",

                     "Trace source indicating a packet has been completely transmitted over the channel",

    .AddTraceSource ("PhyTxDrop", 

                     "Trace source indicating a packet has been dropped by the device during transmission",

                     MakeTraceSourceAccessor (&PointToPointNetDevice::m_phyTxDropTrace))

                     "Trace source indicating a packet has begun being received by the device",

                     "Trace source indicating a packet has been completely received by the device",

    .AddTraceSource ("PhyRxDrop", 

                     "Trace source indicating a packet has been dropped by the device during reception",

                     MakeTraceSourceAccessor (&PointToPointNetDevice::m_phyRxDropTrace))

    //

    // Trace sources designed to simulate a packet sniffer facility (tcpdump).

    //

    .AddTraceSource ("Sniffer", 

                     "Trace source simulating a non-promiscuous packet sniffer attached to the device",

                     MakeTraceSourceAccessor (&PointToPointNetDevice::m_snifferTrace))

    .AddTraceSource ("PromiscSniffer", 

                     "Trace source simulating a promiscuous packet sniffer attached to the device",

                     MakeTraceSourceAccessor (&PointToPointNetDevice::m_promiscSnifferTrace))

    ;

  return tid;

}

PointToPointNetDevice::PointToPointNetDevice () 

: 

  m_txMachineState (READY),

  m_channel (0), 

  m_name (""),

  m_linkUp (false),

  m_currentPkt (0)

{

  NS_LOG_FUNCTION (this);

  //

  // A quick sanity check to ensure consistent constants.

  //

  PppHeader ppp;

  NS_ASSERT_MSG (PPP_OVERHEAD == ppp.GetSerializedSize (), 

                 "PointToPointNetDevice::PointToPointNetDevice(): PPP_OVERHEAD inconsistent");

  m_frameSize = DEFAULT_FRAME_SIZE;

  m_mtu = MtuFromFrameSize (m_frameSize);

}

PointToPointNetDevice::~PointToPointNetDevice ()

{

}

  void 

PointToPointNetDevice::AddHeader(Ptr<Packet> p, uint16_t protocolNumber)

{

  NS_LOG_FUNCTION_NOARGS ();

  NS_ASSERT_MSG (protocolNumber == 0x800, "PointToPointNetDevice::AddHeader(): protocolNumber must be 0x800");

  PppHeader ppp;

  p->AddHeader (ppp);

}

  bool 

PointToPointNetDevice::ProcessHeader(Ptr<Packet> p, uint16_t& param)

{

  NS_LOG_FUNCTION_NOARGS ();

  PppHeader ppp;

  p->RemoveHeader (ppp);

  param = 0x800;

  return true;

}

  void 

PointToPointNetDevice::DoDispose()

{

  NS_LOG_FUNCTION_NOARGS ();

  m_node = 0;

  m_channel = 0;

  m_receiveErrorModel = 0;

  m_currentPkt = 0;

  NetDevice::DoDispose ();

}

  void 

PointToPointNetDevice::SetDataRate(DataRate bps)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_bps = bps;

}

  void 

PointToPointNetDevice::SetInterframeGap(Time t)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_tInterframeGap = t;

}

  bool

PointToPointNetDevice::TransmitStart (Ptr<Packet> p)

{

  NS_LOG_FUNCTION (this << p);

  NS_LOG_LOGIC ("UID is " << p->GetUid () << ")");

  //

  // This function is called to start the process of transmitting a packet.

  // We need to tell the channel that we've started wiggling the wire and

  // schedule an event that will be executed when the transmission is complete.

  //

  NS_ASSERT_MSG(m_txMachineState == READY, "Must be READY to transmit");

  m_txMachineState = BUSY;

  m_currentPkt = p;

  Time txTime = Seconds (m_bps.CalculateTxTime(p->GetSize()));

  Time txCompleteTime = txTime + m_tInterframeGap;

  NS_LOG_LOGIC ("Schedule TransmitCompleteEvent in " << txCompleteTime.GetSeconds () << "sec");

  Simulator::Schedule (txCompleteTime, &PointToPointNetDevice::TransmitComplete, this);

  bool result = m_channel->TransmitStart(p, this, txTime); 

  if (result == false)

    {

      m_phyTxDropTrace (p);

    }

  return result;

}

  void 

PointToPointNetDevice::TransmitComplete (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  //

  // This function is called to when we're all done transmitting a packet.

  // We try and pull another packet off of the transmit queue.  If the queue

  // is empty, we are done, otherwise we need to start transmitting the

  // next packet.

  //

  NS_ASSERT_MSG(m_txMachineState == BUSY, "Must be BUSY if transmitting");

  m_txMachineState = READY;

  NS_ASSERT_MSG (m_currentPkt != 0, "PointToPointNetDevice::TransmitComplete(): m_currentPkt zero");

  m_currentPkt = 0;

  Ptr<Packet> p = m_queue->Dequeue ();

  if (p == 0)

    {

      //

      // No packet was on the queue, so we just exit.

      //

      return;

    }

  //

  // Got another packet off of the queue, so start the transmit process agin.

  //

  m_snifferTrace (p);

  TransmitStart(p);

}

  bool 

PointToPointNetDevice::Attach (Ptr<PointToPointChannel> ch)

{

  NS_LOG_FUNCTION (this << &ch);

  m_channel = ch;

  m_channel->Attach(this);

  //

  // This device is up whenever it is attached to a channel.  A better plan

  // would be to have the link come up when both devices are attached, but this

  // is not done for now.

  //

  NotifyLinkUp ();

  return true;

}

  void

PointToPointNetDevice::SetQueue (Ptr<Queue> q)

{

  NS_LOG_FUNCTION (this << q);

  m_queue = q;

}

  void

PointToPointNetDevice::SetReceiveErrorModel (Ptr<ErrorModel> em)

{

  NS_LOG_FUNCTION (this << em);

  m_receiveErrorModel = em;

}

 void

PointToPointNetDevice::Receive (Ptr<Packet> packet)

{

  NS_LOG_FUNCTION (this << packet);

  uint16_t protocol = 0;

  if (m_receiveErrorModel && m_receiveErrorModel->IsCorrupt (packet) ) 

    {

      // 

      // If we have an error model and it indicates that it is time to lose a

      // corrupted packet, don't forward this packet up, let it go.

      //

      m_phyRxDropTrace (packet);

    }

  else 

    {

      // 

      // Hit the trace hooks.  All of these hooks are in the same place in this 

      // device becuase it is so simple, but this is not usually the case.  

      //

      m_snifferTrace (packet);

      m_macRxTrace (packet);

      //

      // Strip off the point-to-point protocol header and forward this packet

      // up the protocol stack.  Since this is a simple point-to-point link,

      // there is no difference in what the promisc callback sees and what the

      // normal receive callback sees.

      //

      ProcessHeader(packet, protocol);

      if (!m_promiscCallback.IsNull ())

        {

          Ptr<Packet> pktCopy = packet->Copy ();

          m_promiscCallback (this, pktCopy, protocol, GetRemote (), GetAddress (), NetDevice::PACKET_HOST);

        }

      m_rxCallback (this, packet, protocol, GetRemote ());

    }

}

  Ptr<Queue> 

PointToPointNetDevice::GetQueue(void) const 

{ 

  NS_LOG_FUNCTION_NOARGS ();

  return m_queue;

}

  void

PointToPointNetDevice::NotifyLinkUp (void)

{

  m_linkUp = true;

  if (!m_linkChangeCallback.IsNull ())

    {

      m_linkChangeCallback ();

    }

}

  void 

PointToPointNetDevice::SetName(const std::string name)

{

  m_name = name;

}

  std::string 

PointToPointNetDevice::GetName(void) const

{

  return m_name;

}

  void 

PointToPointNetDevice::SetIfIndex(const uint32_t index)

{

  m_ifIndex = index;

}

  uint32_t 

PointToPointNetDevice::GetIfIndex(void) const

{

  return m_ifIndex;

}

  Ptr<Channel> 

PointToPointNetDevice::GetChannel (void) const

{

  return m_channel;

}

//

// This is a point-to-point device, so we really don't need any kind of address

// information.  However, the base class NetDevice wants us to define the

// methods to get and set the address.  Rather than be rude and assert, we let

// clients get and set the address, but simply ignore them.

  void 

PointToPointNetDevice::SetAddress (Mac48Address addr)

{

  m_address = addr;

}

  Address 

PointToPointNetDevice::GetAddress (void) const

{

  return m_address;

}

  bool 

PointToPointNetDevice::IsLinkUp (void) const

{

  return m_linkUp;

}

  void 

PointToPointNetDevice::SetLinkChangeCallback (Callback<void> callback)

{

  m_linkChangeCallback = callback;

}

//

// This is a point-to-point device, so every transmission is a broadcast to

// all of the devices on the network.

//

  bool 

PointToPointNetDevice::IsBroadcast (void) const

{

  return true;

}

//

// We don't really need any addressing information since this is a 

// point-to-point device.  The base class NetDevice wants us to return a

// broadcast address, so we make up something reasonable.

//

  Address

PointToPointNetDevice::GetBroadcast (void) const

{

  return Mac48Address ("ff:ff:ff:ff:ff:ff");

}

//

// We don't deal with multicast here.  It doesn't make sense to include some

// of the one destinations on the network but exclude some of the others.

//

  bool 

PointToPointNetDevice::IsMulticast (void) const

{

  return false;

}

  Address 

PointToPointNetDevice::GetMulticast (Ipv4Address multicastGroup) const

{

  return Mac48Address ("01:00:5e:00:00:00");

}

Address

PointToPointNetDevice::GetMulticast (Ipv6Address addr) const

{

  NS_LOG_FUNCTION(this << addr);

  return Mac48Address ("33:33:00:00:00:00");

}

  bool 

PointToPointNetDevice::IsPointToPoint (void) const

{

  return true;

}

  bool 

PointToPointNetDevice::IsBridge (void) const

{

  return false;

}