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

/*

 * Copyright (c) 2005,2006 INRIA

 *

 * 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

 *

 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 */

#include "packet.h"

#include "ns3/assert.h"

#include "ns3/log.h"

#include "ns3/simulator.h"

#include <string>

#include <cstdarg>

namespace ns3 {

NS_LOG_COMPONENT_DEFINE ("Packet");

uint32_t Packet::m_globalUid = 0;

TypeId 

ByteTagIterator::Item::GetTypeId (void) const

{

  return m_tid;

}

uint32_t 

ByteTagIterator::Item::GetStart (void) const

{

  return m_start;

}

uint32_t 

ByteTagIterator::Item::GetEnd (void) const

{

  return m_end;

}

void 

ByteTagIterator::Item::GetTag (Tag &tag) const

{

  if (tag.GetInstanceTypeId () != GetTypeId ())

    {

      NS_FATAL_ERROR ("The tag you provided is not of the right type.");

    }

  tag.Deserialize (m_buffer);

}

ByteTagIterator::Item::Item (TypeId tid, uint32_t start, uint32_t end, TagBuffer buffer)

  : m_tid (tid),

    m_start (start),

    m_end (end),

    m_buffer (buffer)

{

}

bool

ByteTagIterator::HasNext (void) const

{

  return m_current.HasNext ();

}

ByteTagIterator::Item

ByteTagIterator::Next (void)

{

  ByteTagList::Iterator::Item i = m_current.Next ();

  return ByteTagIterator::Item (i.tid,

                                i.start-m_current.GetOffsetStart (),

                                i.end-m_current.GetOffsetStart (),

                                i.buf);

}

ByteTagIterator::ByteTagIterator (ByteTagList::Iterator i)

  : m_current (i)

{

}

PacketTagIterator::PacketTagIterator (const struct PacketTagList::TagData *head)

  : m_current (head)

{

}

bool

PacketTagIterator::HasNext (void) const

{

  return m_current != 0;

}

PacketTagIterator::Item

PacketTagIterator::Next (void)

{

  NS_ASSERT (HasNext ());

  const struct PacketTagList::TagData *prev = m_current;

  m_current = m_current->next;

  return PacketTagIterator::Item (prev);

}

PacketTagIterator::Item::Item (const struct PacketTagList::TagData *data)

  : m_data (data)

{

}

TypeId

PacketTagIterator::Item::GetTypeId (void) const

{

  return m_data->tid;

}

void

PacketTagIterator::Item::GetTag (Tag &tag) const

{

  NS_ASSERT (tag.GetInstanceTypeId () == m_data->tid);

  tag.Deserialize (TagBuffer ((uint8_t*)m_data->data,

                              (uint8_t*)m_data->data

                              + PacketTagList::TagData::MAX_SIZE));

}

Ptr<Packet> 

Packet::Copy (void) const

{

  // we need to invoke the copy constructor directly

  // rather than calling Create because the copy constructor

  // is private.

  return Ptr<Packet> (new Packet (*this), false);

}

Packet::Packet ()

  : m_buffer (),

    m_byteTagList (),

    m_packetTagList (),

    /* The upper 32 bits of the packet id in 

     * metadata is for the system id. For non-

     * distributed simulations, this is simply 

     * zero.  The lower 32 bits are for the 

     * global UID

     */

    m_metadata (static_cast<uint64_t> (Simulator::GetSystemId ()) << 32 | m_globalUid, 0),

    m_nixVector (0)

{

  m_globalUid++;

}

Packet::Packet (const Packet &o)

  : m_buffer (o.m_buffer),

    m_byteTagList (o.m_byteTagList),

    m_packetTagList (o.m_packetTagList),

    m_metadata (o.m_metadata)

{

  o.m_nixVector ? m_nixVector = o.m_nixVector->Copy ()

    : m_nixVector = 0;

}

Packet &

Packet::operator = (const Packet &o)

{

  if (this == &o)

    {

      return *this;

    }

  m_buffer = o.m_buffer;

  m_byteTagList = o.m_byteTagList;

  m_packetTagList = o.m_packetTagList;

  m_metadata = o.m_metadata;

  o.m_nixVector ? m_nixVector = o.m_nixVector->Copy () 

    : m_nixVector = 0;

  return *this;

}

Packet::Packet (uint32_t size)

  : m_buffer (size),

    m_byteTagList (),

    m_packetTagList (),

    /* The upper 32 bits of the packet id in 

     * metadata is for the system id. For non-

     * distributed simulations, this is simply 

     * zero.  The lower 32 bits are for the 

     * global UID

     */

    m_metadata (static_cast<uint64_t> (Simulator::GetSystemId ()) << 32 | m_globalUid, size),

    m_nixVector (0)

{

  m_globalUid++;

}

Packet::Packet (uint8_t const *buffer, uint32_t size, bool magic)

  : m_buffer (0, false),

    m_byteTagList (),

    m_packetTagList (),

    m_metadata (0,0),

    m_nixVector (0)

{

  NS_ASSERT (magic);

  Deserialize (buffer, size);

}

Packet::Packet (uint8_t const*buffer, uint32_t size)

  : m_buffer (),

    m_byteTagList (),

    m_packetTagList (),

    /* The upper 32 bits of the packet id in 

     * metadata is for the system id. For non-

     * distributed simulations, this is simply 

     * zero.  The lower 32 bits are for the 

     * global UID

     */

    m_metadata (static_cast<uint64_t> (Simulator::GetSystemId ()) << 32 | m_globalUid, size),

    m_nixVector (0)

{

  m_globalUid++;

  m_buffer.AddAtStart (size);

  Buffer::Iterator i = m_buffer.Begin ();

  i.Write (buffer, size);

}

Packet::Packet (const Buffer &buffer,  const ByteTagList &byteTagList, 

                const PacketTagList &packetTagList, const PacketMetadata &metadata)

  : m_buffer (buffer),

    m_byteTagList (byteTagList),

    m_packetTagList (packetTagList),

    m_metadata (metadata),

    m_nixVector (0)

{

}

Ptr<Packet>

Packet::CreateFragment (uint32_t start, uint32_t length) const

{

  NS_LOG_FUNCTION (this << start << length);

  Buffer buffer = m_buffer.CreateFragment (start, length);

  NS_ASSERT (m_buffer.GetSize () >= start + length);

  uint32_t end = m_buffer.GetSize () - (start + length);

  PacketMetadata metadata = m_metadata.CreateFragment (start, end);

  // again, call the constructor directly rather than

  // through Create because it is private.

}

void

Packet::SetNixVector (Ptr<NixVector> nixVector)

{

  m_nixVector = nixVector;

}

Ptr<NixVector>

Packet::GetNixVector (void) const

{

  return m_nixVector;

} 

void

Packet::AddHeader (const Header &header)

{

  uint32_t size = header.GetSerializedSize ();

  NS_LOG_FUNCTION (this << header.GetInstanceTypeId ().GetName () << size);

  m_buffer.AddAtStart (size);

  header.Serialize (m_buffer.Begin ());

  m_metadata.AddHeader (header, size);

}

uint32_t

Packet::RemoveHeader (Header &header)

{

  uint32_t deserialized = header.Deserialize (m_buffer.Begin ());

  NS_LOG_FUNCTION (this << header.GetInstanceTypeId ().GetName () << deserialized);

  m_buffer.RemoveAtStart (deserialized);

  m_metadata.RemoveHeader (header, deserialized);

  return deserialized;

}

uint32_t

Packet::PeekHeader (Header &header) const

{

  uint32_t deserialized = header.Deserialize (m_buffer.Begin ());

  NS_LOG_FUNCTION (this << header.GetInstanceTypeId ().GetName () << deserialized);

  return deserialized;

}

void

Packet::AddTrailer (const Trailer &trailer)

{

  uint32_t size = trailer.GetSerializedSize ();

  NS_LOG_FUNCTION (this << trailer.GetInstanceTypeId ().GetName () << size);

  m_buffer.AddAtEnd (size);

  Buffer::Iterator end = m_buffer.End ();

  trailer.Serialize (end);

  m_metadata.AddTrailer (trailer, size);

}

uint32_t

Packet::RemoveTrailer (Trailer &trailer)

{

  uint32_t deserialized = trailer.Deserialize (m_buffer.End ());

  NS_LOG_FUNCTION (this << trailer.GetInstanceTypeId ().GetName () << deserialized);

  m_buffer.RemoveAtEnd (deserialized);

  m_metadata.RemoveTrailer (trailer, deserialized);

  return deserialized;

}

uint32_t

Packet::PeekTrailer (Trailer &trailer)

{

  uint32_t deserialized = trailer.Deserialize (m_buffer.End ());

  NS_LOG_FUNCTION (this << trailer.GetInstanceTypeId ().GetName () << deserialized);

  return deserialized;

}

void 

Packet::AddAtEnd (Ptr<const Packet> packet)

{

  NS_LOG_FUNCTION (this << packet << packet->GetSize ());

  m_buffer.AddAtEnd (packet->m_buffer);

  m_metadata.AddAtEnd (packet->m_metadata);

}

void

Packet::AddPaddingAtEnd (uint32_t size)

{

  NS_LOG_FUNCTION (this << size);

  m_buffer.AddAtEnd (size);

  m_metadata.AddPaddingAtEnd (size);

}

void 

Packet::RemoveAtEnd (uint32_t size)

{

  NS_LOG_FUNCTION (this << size);

  m_buffer.RemoveAtEnd (size);

  m_metadata.RemoveAtEnd (size);

}

void 

Packet::RemoveAtStart (uint32_t size)

{

  NS_LOG_FUNCTION (this << size);

  m_buffer.RemoveAtStart (size);

  m_metadata.RemoveAtStart (size);

}

void 

Packet::RemoveAllByteTags (void)

{

  NS_LOG_FUNCTION (this);

  m_byteTagList.RemoveAll ();

}

uint32_t 

Packet::CopyData (uint8_t *buffer, uint32_t size) const

{

  return m_buffer.CopyData (buffer, size);

}

void

Packet::CopyData (std::ostream *os, uint32_t size) const

{

  return m_buffer.CopyData (os, size);

}

uint64_t 

Packet::GetUid (void) const

{

  return m_metadata.GetUid ();

}

void 

Packet::PrintByteTags (std::ostream &os) const

{

  ByteTagIterator i = GetByteTagIterator ();

  while (i.HasNext ())

    {

      ByteTagIterator::Item item = i.Next ();

      os << item.GetTypeId ().GetName () << " [" << item.GetStart () << "-" << item.GetEnd () << "]";

      Callback<ObjectBase *> constructor = item.GetTypeId ().GetConstructor ();

      if (constructor.IsNull ())

        {

          if (i.HasNext ())

            {

              os << " ";

            }

          continue;

        }

      Tag *tag = dynamic_cast<Tag *> (constructor ());

      NS_ASSERT (tag != 0);

      os << " ";

      item.GetTag (*tag);

      tag->Print (os);

      if (i.HasNext ())

        {

          os << " ";

        }

      delete tag;

    }

}

std::string

Packet::ToString() const

{

  std::ostringstream oss;

  Print (oss);

  return oss.str();

}

void 

Packet::Print (std::ostream &os) const

{

  PacketMetadata::ItemIterator i = m_metadata.BeginItem (m_buffer);

  while (i.HasNext ())

    {

      PacketMetadata::Item item = i.Next ();

      if (item.isFragment)

        {

          switch (item.type) {

            case PacketMetadata::Item::PAYLOAD:

              os << "Payload";

              break;

            case PacketMetadata::Item::HEADER:

            case PacketMetadata::Item::TRAILER:

              os << item.tid.GetName ();

              break;

            }

          os << " Fragment [" << item.currentTrimedFromStart<<":"

             << (item.currentTrimedFromStart + item.currentSize) << "]";

        }

      else

        {

          switch (item.type) {

            case PacketMetadata::Item::PAYLOAD:

              os << "Payload (size=" << item.currentSize << ")";

              break;

            case PacketMetadata::Item::HEADER:

            case PacketMetadata::Item::TRAILER:

              os << item.tid.GetName () << " (";

              {

                NS_ASSERT (item.tid.HasConstructor ());

                Callback<ObjectBase *> constructor = item.tid.GetConstructor ();

                NS_ASSERT (!constructor.IsNull ());

                ObjectBase *instance = constructor ();

                NS_ASSERT (instance != 0);

                Chunk *chunk = dynamic_cast<Chunk *> (instance);

                NS_ASSERT (chunk != 0);

                chunk->Deserialize (item.current);

                chunk->Print (os);

                delete chunk;

              }

              os << ")";

              break;

            }

        }

      if (i.HasNext ())

        {

          os << " ";

        }

    }

#if 0

  // The code below will work only if headers and trailers

  // define the right attributes which is not the case for

  // now. So, as a temporary measure, we use the 

  // headers' and trailers' Print method as shown above.

  PacketMetadata::ItemIterator i = m_metadata.BeginItem (m_buffer);

  while (i.HasNext ())

    {

      PacketMetadata::Item item = i.Next ();

      if (item.isFragment)

        {

          switch (item.type) {

            case PacketMetadata::Item::PAYLOAD:

              os << "Payload";

              break;

            case PacketMetadata::Item::HEADER:

            case PacketMetadata::Item::TRAILER:

              os << item.tid.GetName ();

              break;

            }

          os << " Fragment [" << item.currentTrimedFromStart<<":"

             << (item.currentTrimedFromStart + item.currentSize) << "]";

        }

      else

        {

          switch (item.type) {