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

/*

 * Copyright (c) 2007 INESC Porto

 * All rights reserved.

 *

 * 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: Gustavo J. A. M. Carneiro  <gjc@inescporto.pt>

 */

#include "ns3/assert.h"

#include "olsr-header.h"

#define IPV4_ADDRESS_SIZE 4

#define OLSR_MSG_HEADER_SIZE 12

#define OLSR_PKT_HEADER_SIZE 4

namespace ns3 {

// ---------------- OLSR Packet -------------------------------

OlsrPacketHeader::OlsrPacketHeader ()

{}

OlsrPacketHeader::~OlsrPacketHeader ()

{}

uint32_t 

OlsrPacketHeader::GetSerializedSize (void) const

{

  return OLSR_PKT_HEADER_SIZE;

}

void 

OlsrPacketHeader::PrintTo (std::ostream &os) const

{

  // TODO

}

void

OlsrPacketHeader::SerializeTo (Buffer::Iterator start) const

{

  Buffer::Iterator i = start;

  i.WriteHtonU16 (m_packetLength);

  i.WriteHtonU16 (m_packetSequenceNumber);

}

uint32_t

OlsrPacketHeader::DeserializeFrom (Buffer::Iterator start)

{

  Buffer::Iterator i = start;

  m_packetLength  = i.ReadNtohU16 ();

  m_packetSequenceNumber = i.ReadNtohU16 ();

  return GetSerializedSize ();

}

// ---------------- OLSR Message -------------------------------

OlsrMessageHeader::OlsrMessageHeader ()

{}

OlsrMessageHeader::~OlsrMessageHeader ()

{}

uint32_t 

OlsrMessageHeader::GetSerializedSize (void) const

{

  return OLSR_MSG_HEADER_SIZE;

}

void 

OlsrMessageHeader::PrintTo (std::ostream &os) const

{

  // TODO

}

void

OlsrMessageHeader::SerializeTo (Buffer::Iterator start) const

{

  Buffer::Iterator i = start;

  i.WriteU8 (m_messageType);

  i.WriteU8 (m_VTime);

  i.WriteHtonU16 (m_messageSize);

  i.WriteHtonU32 (m_originatorAddress.GetHostOrder ());

  i.WriteU8 (m_timeToLive);

  i.WriteU8 (m_hopCount);

  i.WriteHtonU16 (m_messageSequenceNumber);

}

uint32_t

OlsrMessageHeader::DeserializeFrom (Buffer::Iterator start)

{

  Buffer::Iterator i = start;

  m_messageType  = i.ReadU8 ();

  m_VTime  = i.ReadU8 ();

  m_messageSize  = i.ReadNtohU16 ();

  m_originatorAddress = Ipv4Address (i.ReadNtohU32 ());

  m_timeToLive  = i.ReadU8 ();

  m_hopCount  = i.ReadU8 ();

  m_messageSequenceNumber = i.ReadNtohU16 ();

  return GetSerializedSize ();

}

// ---------------- OLSR MID Message -------------------------------

OlsrMidMessageHeader::OlsrMidMessageHeader ()

{}

OlsrMidMessageHeader::~OlsrMidMessageHeader ()

{}

uint32_t 

OlsrMidMessageHeader::GetSerializedSize (void) const

{

  return m_interfaceAddresses.size () * IPV4_ADDRESS_SIZE;

}

void 

OlsrMidMessageHeader::PrintTo (std::ostream &os) const

{

  // TODO

}

void

OlsrMidMessageHeader::SerializeTo (Buffer::Iterator start) const

{

  Buffer::Iterator i = start;

  for (std::list<Ipv4Address>::const_iterator iter = m_interfaceAddresses.begin ();

       iter != m_interfaceAddresses.end (); iter++)

    {

      i.WriteHtonU32 (iter->GetHostOrder ());

    }

}

uint32_t

OlsrMidMessageHeader::DeserializeFrom (Buffer::Iterator start)

{

  Buffer::Iterator i = start;

  m_interfaceAddresses.clear ();

  NS_ASSERT (m_messageSize >= 0);

  NS_ASSERT (m_messageSize % IPV4_ADDRESS_SIZE == 0);

  int numAddresses = m_messageSize / IPV4_ADDRESS_SIZE;

  m_interfaceAddresses.erase (m_interfaceAddresses.begin(),

                              m_interfaceAddresses.end ());

  for (int n = 0; n < numAddresses; ++n)

      m_interfaceAddresses.push_back (Ipv4Address (i.ReadNtohU32 ()));

  return GetSerializedSize ();

}

}; // namespace ns3

#ifdef RUN_SELF_TESTS

#include "ns3/test.h"

#include "ns3/packet.h"

namespace ns3 {

class OlsrHeaderTest : public ns3::Test {

private:

public:

  OlsrHeaderTest ();

  virtual bool RunTests (void);

};

OlsrHeaderTest::OlsrHeaderTest ()

  : ns3::Test ("OlsrHeader")

{}

#define NS_TEST_ASSERT_EQUAL(got, expected)             \

    if ((got) != (expected))                            \

      {                                                 \

        Failure () << __FILE__ << ":" <<__LINE__        \

                   << ": expected " << (expected)       \

                   << ", got " << (got) << std::endl;   \

        result = false;                                 \

      }

bool 

OlsrHeaderTest::RunTests (void)

{

  bool result = true;

  Packet packet;

  {

    OlsrPacketHeader hdr;

    Packet pkt1;

    OlsrMessageHeader msg1;

    OlsrMidMessageHeader mid1;

    Packet pkt2;

    OlsrMessageHeader msg2;

    OlsrMidMessageHeader mid2;

    // MID message #1

    mid1.m_interfaceAddresses.push_back (Ipv4Address ("1.2.3.4"));

    mid1.m_interfaceAddresses.push_back (Ipv4Address ("1.2.3.5"));

    pkt1.AddHeader (mid1);

    msg1.m_messageSize = pkt1.GetSize ();

    msg1.m_timeToLive = 255;

    msg1.m_originatorAddress = Ipv4Address ("11.22.33.44");

    msg1.m_VTime = 9;

    msg1.m_messageType = OlsrMessageHeader::MID_MESSAGE;

    msg1.m_messageSequenceNumber = 7;

    pkt1.AddHeader (msg1);

    packet.AddAtEnd (pkt1);

    // MID message #2

    mid2.m_interfaceAddresses.push_back (Ipv4Address ("2.2.3.4"));

    mid2.m_interfaceAddresses.push_back (Ipv4Address ("2.2.3.5"));

    pkt2.AddHeader (mid2);

    msg2.m_messageSize = pkt2.GetSize ();

    msg2.m_timeToLive = 255;

    msg2.m_originatorAddress = Ipv4Address ("12.22.33.44");

    msg2.m_VTime = 9;

    msg2.m_messageType = OlsrMessageHeader::MID_MESSAGE;

    msg2.m_messageSequenceNumber = 7;

    pkt2.AddHeader (msg2);

    // Build an OLSR packet with the two messages

    hdr.m_packetLength = pkt1.GetSize () + pkt2.GetSize ();

    hdr.m_packetSequenceNumber = 123;

    packet.AddAtEnd (pkt2);

    packet.AddHeader (hdr);

  }    

  return result;

}

static OlsrHeaderTest gOlsrHeaderTest;

}; // namespace

#endif /* RUN_SELF_TESTS */

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

/*

 * Copyright (c) 2007 INESC Porto

 * All rights reserved.

 *

 * 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: Gustavo J. A. M. Carneiro  <gjc@inescporto.pt>

 */

#ifndef OLSR_HEADER_H

#define OLSR_HEADER_H

#include <stdint.h>

#include <list>

#include "ns3/header.h"

#include "ns3/ipv4-address.h"

namespace ns3 {

// 3.3.  Packet Format

//

//    The basic layout of any packet in OLSR is as follows (omitting IP and

//    UDP headers):

//

//        0                   1                   2                   3

//        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |         Packet Length         |    Packet Sequence Number     |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |  Message Type |     Vtime     |         Message Size          |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |                      Originator Address                       |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |  Time To Live |   Hop Count   |    Message Sequence Number    |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |                                                               |

//       :                            MESSAGE                            :

//       |                                                               |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |  Message Type |     Vtime     |         Message Size          |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |                      Originator Address                       |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |  Time To Live |   Hop Count   |    Message Sequence Number    |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |                                                               |

//       :                            MESSAGE                            :

//       |                                                               |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       :                                                               :

//                (etc.)

class OlsrPacketHeader : public Header

{

public:

  OlsrPacketHeader ();

  virtual ~OlsrPacketHeader ();

  uint16_t m_packetLength;

  uint16_t m_packetSequenceNumber;

private:

  virtual void PrintTo (std::ostream &os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void SerializeTo (Buffer::Iterator start) const;

  virtual uint32_t DeserializeFrom (Buffer::Iterator start);

};

//        0                   1                   2                   3

//        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |  Message Type |     Vtime     |         Message Size          |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |                      Originator Address                       |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |  Time To Live |   Hop Count   |    Message Sequence Number    |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

class OlsrMessageHeader : public Header

{

public:

  enum MessageTypes {

    HELLO_MESSAGE         = 1,

    TC_MESSAGE            = 2,

    MID_MESSAGE           = 3,

    HNA_MESSAGE           = 4,

  };

  OlsrMessageHeader ();

  virtual ~OlsrMessageHeader ();

  uint8_t m_messageType;

  uint8_t m_VTime;

  uint16_t m_messageSize;

  Ipv4Address m_originatorAddress;

  uint8_t m_timeToLive;

  uint8_t m_hopCount;

  uint16_t m_messageSequenceNumber;

private:

  virtual void PrintTo (std::ostream &os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void SerializeTo (Buffer::Iterator start) const;

  virtual uint32_t DeserializeFrom (Buffer::Iterator start);

};

// 5.1.  MID Message Format

//

//    The proposed format of a MID message is as follows:

//

//        0                   1                   2                   3

//        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |                    OLSR Interface Address                     |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |                    OLSR Interface Address                     |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

//       |                              ...                              |

//       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

class OlsrMidMessageHeader : public Header

{

public:

  OlsrMidMessageHeader ();

  virtual ~OlsrMidMessageHeader ();

  uint32_t m_messageSize; // has to be manually set before deserialization

  std::list<Ipv4Address> m_interfaceAddresses;

private:

  virtual void PrintTo (std::ostream &os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void SerializeTo (Buffer::Iterator start) const;

  virtual uint32_t DeserializeFrom (Buffer::Iterator start);

};

}; // namespace ns3

#endif /* OLSR_HEADER_H */

## -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-

def configure(conf):

    conf.env.append_value('NS3_MODULES', 'ns3-olsr')

def build(bld):

    obj = bld.create_obj('cpp', 'shlib')

    obj.name = 'ns3-olsr'

    obj.target = obj.name

    obj.uselib_local = ['ns3-internet-node']

    obj.source = [

        'olsr-header.cc',

        ]

    #headers = bld.create_obj('ns3header')

    #headers.source = [

    #    'olsr-header.h',

    #    ]

    'routing/olsr',