Attachment #2249 for bug #938

View | Details | Raw Unified | Return to bug 938
Collapse All | Expand All




  NS_ASSERT (m_ipv4->GetInterfaceForDevice (idev) >= 0);
  uint32_t iif = m_ipv4->GetInterfaceForDevice (idev);

  if (m_ipv4->IsDestinationAddress (header.GetDestination (), iif))
    {
      if (!lcb.IsNull ())
        {
          NS_LOG_LOGIC ("Local delivery to " << header.GetDestination ());
          lcb (p, header, iif);
          return true;
        }
      else
        {
          // The local delivery callback is null.  This may be a multicast
          // or broadcast packet, so return false so that another
          // multicast routing protocol can handle it.  It should be possible
          // to extend this to explicitly check whether it is a unicast
          // packet, and invoke the error callback if so
          return false;
        }
    }

  if (header.GetDestination ().IsBroadcast ())
    {
      NS_LOG_LOGIC ("For me (Ipv4Addr broadcast address)");
      /// \todo  Local Deliver for broadcast
      /// \todo  Forward broadcast
    }

  /// \todo  Configurable option to enable \RFC{1222} Strong End System Model
  // Right now, we will be permissive and allow a source to send us
  // a packet to one of our other interface addresses; that is, the
  // destination unicast address does not match one of the iif addresses,
  // but we check our other interfaces.  This could be an option
  // (to remove the outer loop immediately below and just check iif).
  for (uint32_t j = 0; j < m_ipv4->GetNInterfaces (); j++)
    {
      for (uint32_t i = 0; i < m_ipv4->GetNAddresses (j); i++)
        {
          Ipv4InterfaceAddress iaddr = m_ipv4->GetAddress (j, i);
          Ipv4Address addr = iaddr.GetLocal ();
          if (addr.IsEqual (header.GetDestination ()))
            {
              if (j == iif)
                {
                  NS_LOG_LOGIC ("For me (destination " << addr << " match)");
                }
              else
                {
                  NS_LOG_LOGIC ("For me (destination " << addr << " match) on another interface " << header.GetDestination ());
                }
              lcb (p, header, iif);
              return true;
            }
          if (header.GetDestination ().IsEqual (iaddr.GetBroadcast ()))
            {
              NS_LOG_LOGIC ("For me (interface broadcast address)");
              lcb (p, header, iif);
              return true;
            }
          NS_LOG_LOGIC ("Address "<< addr << " not a match");
        }
    }
  // Check if input device supports IP forwarding
  if (m_ipv4->IsForwarding (iif) == false)
    {




  uint32_t iif = m_ipv4->GetInterfaceForDevice (idev); 

  // Multicast recognition; handle local delivery here

  if (ipHeader.GetDestination ().IsMulticast ())
    {
      NS_LOG_LOGIC ("Multicast destination");

          return false; // Let other routing protocols try to handle this
        }
    }

  if (m_ipv4->IsDestinationAddress (ipHeader.GetDestination (), iif))
    {
      if (!lcb.IsNull ())
        {
          NS_LOG_LOGIC ("Local delivery to " << ipHeader.GetDestination ());
          lcb (p, ipHeader, iif);
          return true;
        }
      else
        {
          // The local delivery callback is null.  This may be a multicast
          // or broadcast packet, so return false so that another
          // multicast routing protocol can handle it.  It should be possible
          // to extend this to explicitly check whether it is a unicast
          // packet, and invoke the error callback if so
          return false;
        }
    }

  NS_LOG_LOGIC ("Unicast destination");
  /// \todo Configurable option to enable \RFC{1222} Strong End System Model
  // Right now, we will be permissive and allow a source to send us
  // a packet to one of our other interface addresses; that is, the
  // destination unicast address does not match one of the iif addresses,
  // but we check our other interfaces.  This could be an option
  // (to remove the outer loop immediately below and just check iif).
  for (uint32_t j = 0; j < m_ipv4->GetNInterfaces (); j++)
    {
      for (uint32_t i = 0; i < m_ipv4->GetNAddresses (j); i++)
        {
          Ipv4InterfaceAddress iaddr = m_ipv4->GetAddress (j, i);
          Ipv4Address addr = iaddr.GetLocal ();
          if (addr.IsEqual (ipHeader.GetDestination ()))
            {
              if (j == iif)
                {
                  NS_LOG_LOGIC ("For me (destination " << addr << " match)");
                }
              else
                {
                  NS_LOG_LOGIC ("For me (destination " << addr << " match) on another interface " << ipHeader.GetDestination ());
                }
              lcb (p, ipHeader, iif);
              return true;
            }
          if (ipHeader.GetDestination ().IsEqual (iaddr.GetBroadcast ()))
            {
              NS_LOG_LOGIC ("For me (interface broadcast address)");
              lcb (p, ipHeader, iif);
              return true;
            }
          NS_LOG_LOGIC ("Address "<< addr << " not a match");
        }
    }
  // Check if input device supports IP forwarding
  if (m_ipv4->IsForwarding (iif) == false)
    {




University of Murcia (Spain) by Francisco J. Ros for NS-2, and was
ported to NS-3 by Gustavo Carneiro at INESC Porto (Portugal).

The implementation is based on OLSR Version 1 (:rfc:`3626`) and
it is *not* compliant with OLSR Version 2 (:rfc:`7181`) or any 
of the Version 2 extensions.
 
Model Description
*****************

The source code for the OLSR model lives in the directory `src/olsr`.
As stated before, the model is based on :rfc:`3626`. Moreover, many
design choices are based on the previous ns2 model.
++++++

Scope and Limitations
+++++++++++++++++++++

++++++++++

.. [rfc3626] :rfc:`3626` *Optimized Link State Routing*
.. [rfc7181] :rfc:`7181` *The Optimized Link State Routing Protocol Version 2*

Usage
*****

The usage pattern is the one of all the Internet routing protocols.
Since OLSR is not installed by default in the Internet stack, it is necessary to
set it in the Internet Stack helper by using ``InternetStackHelper::SetRoutingHelper``

Examples
++++++++

The examples are in the ``src/olsr/examples/`` directory. However, many other examples esists in the
general examples directory, e.g., ``examples/routing/manet-routing-compare.cc``.

For specific examples of the HNA feature, see the examples in ``src/olsr/examples/``.

Helpers
+++++++


MidInterval, Willingness.  Other parameters are defined as macros
in ``olsr-routing-protocol.cc``.

The list of configurabel attributes is:

* HelloInterval (time, default 2s), HELLO messages emission interval.
* TcInterval (time, default 5s), TC messages emission interval.
* MidInterval (time, default 5s), MID messages emission interval.
* HnaInterval (time, default 5s), HNA messages emission interval.
* Willingness (enum, default OLSR_WILL_DEFAULT), Willingness of a node to carry and forward traffic for other nodes.

Tracing
+++++++

The available traces are:

* Rx: Receive OLSR packet.
* Tx: Send OLSR packet.
* RoutingTableChanged: The OLSR routing table has changed.

Caveats
+++++++

The code does not present any known issue.

Validation
**********

The code validationhas been done through Wireshark message compliance and unit testings.
++++++++++

Larger-scale performance tests
++++++++++++++++++++++++++++++


(-)a/src/olsr/helper/olsr-helper.h (+2 lines)

Lines 30-35	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup olsr

 * \brief Helper class that adds OLSR routing to nodes.

 * \brief Helper class that adds OLSR routing to nodes.

 * This class is expected to be used in conjunction with

 * This class is expected to be used in conjunction with




double EmfToSeconds (uint8_t emf);
uint8_t SecondsToEmf (double seconds);

/**
 * \ingroup olsr
 *
 * The basic layout of any packet in OLSR is as follows (omitting IP and
 * UDP headers):
  \verbatim
    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.)
  \endverbatim
  *
  * This header only holds the common part of a message group, i.e.,
  * the first 4 bytes.
  */
class PacketHeader : public Header
{
public:
  PacketHeader ();
  virtual ~PacketHeader ();

  /**
   * Set the packet total length.
   * \param length The packet length.
   */
  void SetPacketLength (uint16_t length)
  {
    m_packetLength = length;
  }

  /**
   * Get the packet total length.
   * \return The packet length.
   */
  uint16_t GetPacketLength () const
  {
    return m_packetLength;
  }

  /**
   * Set the packet sequence number.
   * \param seqnum The packet sequence number.
   */
  void SetPacketSequenceNumber (uint16_t seqnum)
  {
    m_packetSequenceNumber = seqnum;
  }

  /**
   * Get the packet sequence number.
   * \returns The packet sequence number.
   */
  uint16_t GetPacketSequenceNumber () const
  {
    return m_packetSequenceNumber;
  }

private:
  uint16_t m_packetLength;          //!< The packet length.
  uint16_t m_packetSequenceNumber;  //!< The packet sequence number.

public:
  /**
   * \brief Get the type ID.
   * \return The object TypeId.
   */
  static TypeId GetTypeId (void);
  virtual TypeId GetInstanceTypeId (void) const;
  virtual void Print (std::ostream &os) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);
};

/**
 * \ingroup olsr
 *
 * This header can store HELP, TC, MID and HNA messages.
 * The header size is variable, and depends on the
 * actual message type.
 *
  \verbatim
    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    |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   :                            MESSAGE                            :
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  \endverbatim
 */
class MessageHeader : public Header
{
public:

  /**
   * Message type
   */
  enum MessageType {
    HELLO_MESSAGE = 1,
    TC_MESSAGE    = 2,

  MessageHeader ();
  virtual ~MessageHeader ();

  /**
   * Set the message type.
   * \param messageType The message type.
   */
  void SetMessageType (MessageType messageType)
  {
    m_messageType = messageType;
  }
  /**
   * Get the message type.
   * \return The message type.
   */
  MessageType GetMessageType () const
  {
    return m_messageType;
  }

  /**
   * Set the validity time.
   * \param time The validity time.
   */
  void SetVTime (Time time)
  {
    m_vTime = SecondsToEmf (time.GetSeconds ());
  }
  /**
   * Get the validity time.
   * \return The validity time.
   */
  Time GetVTime () const
  {
    return Seconds (EmfToSeconds (m_vTime));
  }

  /**
   * Set the originator address.
   * \param originatorAddress The originator address.
   */
  void SetOriginatorAddress (Ipv4Address originatorAddress)
  {
    m_originatorAddress = originatorAddress;
  }
  /**
   * Get the originator address.
   * \return The originator address.
   */
  Ipv4Address GetOriginatorAddress () const
  {
    return m_originatorAddress;
  }

  /**
   * Set the time to live.
   * \param timeToLive The time to live.
   */
  void SetTimeToLive (uint8_t timeToLive)
  {
    m_timeToLive = timeToLive;
  }
  /**
   * Get the time to live.
   * \return The time to live.
   */
  uint8_t GetTimeToLive () const
  {
    return m_timeToLive;
  }

  /**
   * Set the hop count.
   * \param hopCount The hop count.
   */
  void SetHopCount (uint8_t hopCount)
  {
    m_hopCount = hopCount;
  }
  /**
   * Get the hop count.
   * \return The hop count.
   */
  uint8_t GetHopCount () const
  {
    return m_hopCount;
  }

  /**
   * Set the message sequence number.
   * \param messageSequenceNumber The message sequence number.
   */
  void SetMessageSequenceNumber (uint16_t messageSequenceNumber)
  {
    m_messageSequenceNumber = messageSequenceNumber;
  }
  /**
   * Get the message sequence number.
   * \return The message sequence number.
   */
  uint16_t GetMessageSequenceNumber () const
  {
    return m_messageSequenceNumber;
  }

//   void SetMessageSize (uint16_t messageSize)
//   {
//     m_messageSize = messageSize;
//   }
//   uint16_t GetMessageSize () const
//   {
//     return m_messageSize;
//   }

private:
  MessageType m_messageType;        //!< The message type
  uint8_t m_vTime;                  //!< The validity time.
  Ipv4Address m_originatorAddress;  //!< The originator address.
  uint8_t m_timeToLive;             //!< The time to live.
  uint8_t m_hopCount;               //!< The hop count.
  uint16_t m_messageSequenceNumber; //!< The message sequence number.
  uint16_t m_messageSize;           //!< The message size.

public:
  /**
   * \brief Get the type ID.
   * \return The object TypeId.
   */
  static TypeId GetTypeId (void);
  virtual TypeId GetInstanceTypeId (void) const;
  virtual void Print (std::ostream &os) const;

  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);

  /**
   * \ingroup olsr
   * MID Message Format
   *
  \verbatim
    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                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                              ...                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  \endverbatim
  */
  struct Mid
  {
    std::vector<Ipv4Address> interfaceAddresses;  //!< Interface Address container.
    /**
     * This method is used to print the content of a MID message.
     * \param os output stream
     */
    void Print (std::ostream &os) const;
    /**
     * Returns the expected size of the header.
     * \returns the expected size of the header.
     */
    uint32_t GetSerializedSize (void) const;
    /**
     * This method is used by Packet::AddHeader to
     * store a header into the byte buffer of a packet.
     *
     * \param start an iterator which points to where the header should
     *        be written.
     */
    void Serialize (Buffer::Iterator start) const;
    /**
     * This method is used by Packet::RemoveHeader to
     * re-create a header from the byte buffer of a packet.
     *
     * \param start an iterator which points to where the header should
     *        read from.
     * \param messageSize the message size.
     * \returns the number of bytes read.
     */
   uint32_t Deserialize (Buffer::Iterator start, uint32_t messageSize);
  };

  /**
   * \ingroup olsr
   * HELLO Message Format
   *
  \verbatim
    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

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |          Reserved             |     Htime     |  Willingness  |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |   Link Code   |   Reserved    |       Link Message Size       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                  Neighbor Interface Address                   |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                  Neighbor Interface Address                   |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   :                             .  .  .                           :
   :                                                               :
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |   Link Code   |   Reserved    |       Link Message Size       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                  Neighbor Interface Address                   |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                  Neighbor Interface Address                   |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   :                                                               :
     (etc.)
  \endverbatim
  */
 struct Hello
  {
    /**
     * Link message item
     */
    struct LinkMessage {
      uint8_t linkCode;       //!< Link code
      std::vector<Ipv4Address> neighborInterfaceAddresses;  //!< Neighbor interface address container.
    };

    uint8_t hTime;  //!< HELLO emission interval (coded)

    /**
     * Set the HELLO emission interval.
     * \param time The HELLO emission interval.
     */
    void SetHTime (Time time)
    {
      this->hTime = SecondsToEmf (time.GetSeconds ());
    }

    /**
     * Get the HELLO emission interval.
     * \return The HELLO emission interval.
     */
    Time GetHTime () const
    {
      return Seconds (EmfToSeconds (this->hTime));
    }

    uint8_t willingness; //!< The willingness of a node to carry and forward traffic for other nodes.
    std::vector<LinkMessage> linkMessages; //!< Link messages container.

    /**
     * This method is used to print the content of a MID message.
     * \param os output stream
     */
    void Print (std::ostream &os) const;
    /**
     * Returns the expected size of the header.
     * \returns the expected size of the header.
     */
    uint32_t GetSerializedSize (void) const;
    /**
     * This method is used by Packet::AddHeader to
     * store a header into the byte buffer of a packet.
     *
     * \param start an iterator which points to where the header should
     *        be written.
     */
    void Serialize (Buffer::Iterator start) const;
    /**
     * This method is used by Packet::RemoveHeader to
     * re-create a header from the byte buffer of a packet.
     *
     * \param start an iterator which points to where the header should
     *        read from.
     * \param messageSize the message size.
     * \returns the number of bytes read.
     */
    uint32_t Deserialize (Buffer::Iterator start, uint32_t messageSize);
  };

 /**
  * \ingroup olsr
  * TC Message Format
  *
  \verbatim
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |              ANSN             |           Reserved            |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |               Advertised Neighbor Main Address                |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |               Advertised Neighbor Main Address                |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                              ...                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  \endverbatim
  */
 struct Tc
  {
    std::vector<Ipv4Address> neighborAddresses; //!< Neighbor address container.
    uint16_t ansn;  //!< Advertised Neighbor Sequence Number.

    /**
     * This method is used to print the content of a MID message.
     * \param os output stream
     */

    void Print (std::ostream &os) const;
    /**
     * Returns the expected size of the header.
     * \returns the expected size of the header.
     */
    uint32_t GetSerializedSize (void) const;
    /**
     * This method is used by Packet::AddHeader to
     * store a header into the byte buffer of a packet.
     *
     * \param start an iterator which points to where the header should
     *        be written.
     */
    void Serialize (Buffer::Iterator start) const;
    /**
     * This method is used by Packet::RemoveHeader to
     * re-create a header from the byte buffer of a packet.
     *
     * \param start an iterator which points to where the header should
     *        read from.
     * \param messageSize the message size.
     * \returns the number of bytes read.
     */
   uint32_t Deserialize (Buffer::Iterator start, uint32_t messageSize);
  };


 /**
  * \ingroup olsr
  * HNA (Host Network Association) Message Format
  *
  \verbatim
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                         Network Address                       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             Netmask                           |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                         Network Address                       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             Netmask                           |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                              ...                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  \endverbatim
  */
  struct Hna
  {
   /**
    * Association item structure.
    */
    struct Association
    {
      Ipv4Address address; //!< IPv4 Address.
      Ipv4Mask mask;       //!< IPv4 netmask.
    };
    std::vector<Association> associations;

    std::vector<Association> associations; //!< Association container.

    /**
     * This method is used to print the content of a MID message.
     * \param os output stream
     */
    void Print (std::ostream &os) const;
    /**
     * Returns the expected size of the header.
     * \returns the expected size of the header.
     */
    uint32_t GetSerializedSize (void) const;
    /**
     * This method is used by Packet::AddHeader to
     * store a header into the byte buffer of a packet.
     *
     * \param start an iterator which points to where the header should
     *        be written.
     */
    void Serialize (Buffer::Iterator start) const;
    /**
     * This method is used by Packet::RemoveHeader to
     * re-create a header from the byte buffer of a packet.
     *
     * \param start an iterator which points to where the header should
     *        read from.
     * \param messageSize the message size.
     * \returns the number of bytes read.
     */
    uint32_t Deserialize (Buffer::Iterator start, uint32_t messageSize);
  };

private:

  /**
   * Structure holding the message content.
   */
  struct
  {
    Mid mid;      //!< MID message (optional).
    Hello hello;  //!< HELLO message (optional).
    Tc tc;        //!< TC message (optional).
    Hna hna;      //!< HNA message (optional).
  } m_message; //!< The actual message being carried.

public:

  /**
   * Set the message type to MID and return the message content.
   * \returns The MID message.
   */
  Mid& GetMid ()
  {
    if (m_messageType == 0)

    return m_message.mid;
  }

  /**
   * Set the message type to HELLO and return the message content.
   * \returns The HELLO message.
   */
  Hello& GetHello ()
  {
    if (m_messageType == 0)

    return m_message.hello;
  }

  /**
   * Set the message type to TC and return the message content.
   * \returns The TC message.
   */
  Tc& GetTc ()
  {
    if (m_messageType == 0)

    return m_message.tc;
  }

  /**
   * Set the message type to HNA and return the message content.
   * \returns The HNA message.
   */
  Hna& GetHna ()
  {
    if (m_messageType == 0)

  }


  /**
   * Get the MID message.
   * \returns The MID message.
   */
  const Mid& GetMid () const
  {
    NS_ASSERT (m_messageType == MID_MESSAGE);
    return m_message.mid;
  }

  /**
   * Get the HELLO message.
   * \returns The HELLO message.
   */
  const Hello& GetHello () const
  {
    NS_ASSERT (m_messageType == HELLO_MESSAGE);
    return m_message.hello;
  }

  /**
   * Get the TC message.
   * \returns The TC message.
   */
  const Tc& GetTc () const
  {
    NS_ASSERT (m_messageType == TC_MESSAGE);
    return m_message.tc;
  }

  /**
   * Get the HNA message.
   * \returns The HNA message.
   */
  const Hna& GetHna () const
  {
    NS_ASSERT (m_messageType == HNA_MESSAGE);




namespace ns3 { namespace olsr {


/// \ingroup olsr
/// An Interface Association Tuple.
struct IfaceAssocTuple
{
  /// Interface address of a node.
  Ipv4Address ifaceAddr;
  /// Main address of the node.
  Ipv4Address mainAddr;
  /// Time at which this tuple expires and must be removed.
  Time time;
};

static inline bool
operator == (const IfaceAssocTuple &a, const IfaceAssocTuple &b)
{
  return (a.ifaceAddr == b.ifaceAddr
      && a.mainAddr == b.mainAddr);
}
                  Ipv4Address mainAddr;
                  /// Time at which this tuple expires and must be removed.
                  Time time;
                };

static inline std::ostream&
operator << (std::ostream &os, const IfaceAssocTuple &tuple)
{
  os << "IfaceAssocTuple(ifaceAddr=" << tuple.ifaceAddr
                         << ", mainAddr=" << tuple.mainAddr
                         << ", time=" << tuple.time << ")";
  return os;
}

/// \ingroup olsr
/// A Link Tuple.
struct LinkTuple
{
  /// Interface address of the local node.
  Ipv4Address localIfaceAddr;
  /// Interface address of the neighbor node.
  Ipv4Address neighborIfaceAddr;
  /// The link is considered bidirectional until this time.
  Time symTime;
  /// The link is considered unidirectional until this time.
  Time asymTime;
  /// Time at which this tuple expires and must be removed.
  Time time;
};

static inline bool
operator == (const LinkTuple &a, const LinkTuple &b)
{
  return (a.localIfaceAddr == b.localIfaceAddr
      && a.neighborIfaceAddr == b.neighborIfaceAddr);
}
                  Ipv4Address neighborIfaceAddr;
                  /// The link is considered bidirectional until this time.
                  Time symTime;
                  /// The link is considered unidirectional until this time.
                  Time asymTime;
                  /// Time at which this tuple expires and must be removed.
                  Time time;
                };

static inline std::ostream&
operator << (std::ostream &os, const LinkTuple &tuple)
{
  os << "LinkTuple(localIfaceAddr=" << tuple.localIfaceAddr
                   << ", neighborIfaceAddr=" << tuple.neighborIfaceAddr
                   << ", symTime=" << tuple.symTime
                   << ", asymTime=" << tuple.asymTime
                   << ", expTime=" << tuple.time
                   << ")";
  return os;
}

/// \ingroup olsr
/// A Neighbor Tuple.
struct NeighborTuple
{
  /// Main address of a neighbor node.
  Ipv4Address neighborMainAddr;
  /// Status of the link (Symmetric or not Symmetric).
  enum Status {
    STATUS_NOT_SYM = 0, // "not symmetric"
    STATUS_SYM = 1, // "symmetric"
  } status; //!< Status of the link.
  /// A value between 0 and 7 specifying the node's willingness to carry traffic on behalf of other nodes.
  uint8_t willingness;
};

static inline bool
operator == (const NeighborTuple &a, const NeighborTuple &b)
{
  return (a.neighborMainAddr == b.neighborMainAddr
      && a.status == b.status
      && a.willingness == b.willingness);
}
                    STATUS_NOT_SYM = 0, // "not symmetric"
                    STATUS_SYM = 1, // "symmetric"
                  } status;
                  /// A value between 0 and 7 specifying the node's willingness to carry traffic on behalf of other nodes.
                  uint8_t willingness;
                };

static inline std::ostream&
operator << (std::ostream &os, const NeighborTuple &tuple)
{
  os << "NeighborTuple(neighborMainAddr=" << tuple.neighborMainAddr
                       << ", status=" << (tuple.status == NeighborTuple::STATUS_SYM ? "SYM" : "NOT_SYM")
                       << ", willingness=" << (int) tuple.willingness << ")";
  return os;
}

/// \ingroup olsr
/// A 2-hop Tuple.
struct TwoHopNeighborTuple
{
  /// Main address of a neighbor.
  Ipv4Address neighborMainAddr;
  /// Main address of a 2-hop neighbor with a symmetric link to nb_main_addr.
  Ipv4Address twoHopNeighborAddr;
  /// Time at which this tuple expires and must be removed.
  Time expirationTime; // previously called 'time_'
};

static inline std::ostream&
operator << (std::ostream &os, const TwoHopNeighborTuple &tuple)
{
  os << "TwoHopNeighborTuple(neighborMainAddr=" << tuple.neighborMainAddr
      << ", twoHopNeighborAddr=" << tuple.twoHopNeighborAddr
      << ", expirationTime=" << tuple.expirationTime
      << ")";
  return os;
}
                };

static inline bool
operator == (const TwoHopNeighborTuple &a, const TwoHopNeighborTuple &b)
{
  return (a.neighborMainAddr == b.neighborMainAddr
      && a.twoHopNeighborAddr == b.twoHopNeighborAddr);
}
                  << ")";
                  return os;
                }

/// \ingroup olsr
/// An MPR-Selector Tuple.
struct MprSelectorTuple
{
  /// Main address of a node which have selected this node as a MPR.
  Ipv4Address mainAddr;
  /// Time at which this tuple expires and must be removed.
  Time expirationTime; // previously called 'time_'
};

static inline bool
operator == (const MprSelectorTuple &a, const MprSelectorTuple &b)
{
  return (a.mainAddr == b.mainAddr);
}
                  /// Time at which this tuple expires and must be removed.
                  Time expirationTime; // previously called 'time_'
                };

                static inline bool
                operator == (const MprSelectorTuple &a, const MprSelectorTuple &b)
                {
                  return (a.mainAddr == b.mainAddr);
                }

// The type "list of interface addresses"
/// The type "list of interface addresses"
//typedef std::vector<nsaddr_t> addr_list_t;

/// \ingroup olsr
/// A Duplicate Tuple
struct DuplicateTuple
{
  /// Originator address of the message.
  Ipv4Address address;
  /// Message sequence number.
  uint16_t sequenceNumber;
  /// Indicates whether the message has been retransmitted or not.
  bool retransmitted;
  /// List of interfaces which the message has been received on.
  std::vector<Ipv4Address> ifaceList;
  /// Time at which this tuple expires and must be removed.
  Time expirationTime;
};

static inline bool
operator == (const DuplicateTuple &a, const DuplicateTuple &b)
{
  return (a.address == b.address
      && a.sequenceNumber == b.sequenceNumber);
}

/// \ingroup olsr
/// A Topology Tuple
struct TopologyTuple
{
  /// Main address of the destination.
  Ipv4Address destAddr;
  /// Main address of a node which is a neighbor of the destination.
  Ipv4Address lastAddr;
  /// Sequence number.
  uint16_t sequenceNumber;
  /// Time at which this tuple expires and must be removed.
  Time expirationTime;
};

static inline bool
operator == (const TopologyTuple &a, const TopologyTuple &b)
{
  return (a.destAddr == b.destAddr
      && a.lastAddr == b.lastAddr
      && a.sequenceNumber == b.sequenceNumber);
}

static inline std::ostream&
operator << (std::ostream &os, const TopologyTuple &tuple)
{
  os << "TopologyTuple(destAddr=" << tuple.destAddr
                       << ", lastAddr=" << tuple.lastAddr
                       << ", sequenceNumber=" << (int) tuple.sequenceNumber
                       << ", expirationTime=" << tuple.expirationTime
                       << ")";
  return os;
}

/// \ingroup olsr
/// Association
struct Association
{
  Ipv4Address networkAddr; //!< IPv4 Network address.
  Ipv4Mask netmask;        //!< IPv4 Network mask.
};

static inline bool
operator == (const Association &a, const Association &b)
{
  return (a.networkAddr == b.networkAddr
      && a.netmask == b.netmask);
}

static inline std::ostream&
operator << (std::ostream &os, const Association &tuple)
{
  os << "Association(networkAddr=" << tuple.networkAddr
                     << ", netmask=" << tuple.netmask
                     << ")";
  return os;
}

/// \ingroup olsr
/// An Association Tuple
struct AssociationTuple
{
  /// Main address of the gateway.
  Ipv4Address gatewayAddr;
  /// Network Address of network reachable through gatewayAddr
  Ipv4Address networkAddr;
  /// Netmask of network reachable through gatewayAddr
  Ipv4Mask netmask;
  /// Time at which this tuple expires and must be removed
  Time expirationTime;
};

static inline bool
operator == (const AssociationTuple &a, const AssociationTuple &b)
{
  return (a.gatewayAddr == b.gatewayAddr
      && a.networkAddr == b.networkAddr
      && a.netmask == b.netmask);
}

static inline std::ostream&
operator << (std::ostream &os, const AssociationTuple &tuple)
{
  os << "AssociationTuple(gatewayAddr=" << tuple.gatewayAddr
                          << ", networkAddr=" << tuple.networkAddr
                          << ", netmask=" << tuple.netmask
                          << ", expirationTime=" << tuple.expirationTime
                          << ")";
  return os;
}


typedef std::set<Ipv4Address>                   MprSet; //!< MPR Set type.
typedef std::vector<MprSelectorTuple>           MprSelectorSet; //!< MPR Selector Set type.
typedef std::vector<LinkTuple>                  LinkSet; //!< Link Set type.
typedef std::vector<NeighborTuple>              NeighborSet; //!< Neighbor Set type.
typedef std::vector<TwoHopNeighborTuple>        TwoHopNeighborSet; //!< 2-hop Neighbor Set type.
typedef std::vector<TopologyTuple>              TopologySet; //!< Topology Set type.
typedef std::vector<DuplicateTuple>             DuplicateSet; //!< Duplicate Set type.
typedef std::vector<IfaceAssocTuple>            IfaceAssocSet; //!< Interface Association Set type.
typedef std::vector<AssociationTuple>           AssociationSet; //!< Association Set type.
typedef std::vector<Association>                Associations; //!< Association Set type.


}} // namespace ns3, olsr

#endif /* OLSR_REPOSITORIES_H */

(-)a/src/olsr/model/olsr-routing-protocol.cc (-326 / +6 lines)

Lines 550-556	Link Here

550

551

namespace {

551

namespace {

552

///

552

///

553

/// \brief Remove all covered 2-hop neighbors from N2 set. This is a helper function used by MprComputation algorithm.

553

/// \brief Remove all covered 2-hop neighbors from N2 set.

554

/// This is a helper function used by MprComputation algorithm.

555

///

556

/// \param neighborMainAddr Neighbor main address.

557

/// \param N2 Reference to the 2-hop neighbor set.

554

///

558

///

555

void

559

void

556

CoverTwoHopNeighbors (Ipv4Address neighborMainAddr, TwoHopNeighborSet & N2)

560

CoverTwoHopNeighbors (Ipv4Address neighborMainAddr, TwoHopNeighborSet & N2)

Lines 579-587	Link Here

579

583

580

} // anonymous namespace

584

} // anonymous namespace

581

585

582

///

583

/// \brief Computates MPR set of a node following \RFC{3626} hints.

584

///

585

void

586

void

586

RoutingProtocol::MprComputation ()

587

RoutingProtocol::MprComputation ()

587

588

Lines 869-880	Link Here

869

  m_state.SetMprSet (mprSet);

870

  m_state.SetMprSet (mprSet);

870

871

872

///

873

/// \brief Gets the main address associated with a given interface address.

874

///

875

/// \param iface_addr the interface address.

876

/// \return the corresponding main address.

877

///

878

Ipv4Address

873

Ipv4Address

879

RoutingProtocol::GetMainAddress (Ipv4Address iface_addr) const

874

RoutingProtocol::GetMainAddress (Ipv4Address iface_addr) const

880

875

Lines 887-895	Link Here

887

    return iface_addr;

882

    return iface_addr;

888

883

889

884

890

///

891

/// \brief Creates the routing table of the node following \RFC{3626} hints.

892

///

893

void

885

void

894

RoutingProtocol::RoutingTableComputation ()

886

RoutingProtocol::RoutingTableComputation ()

895

887

Lines 1205-1220	Link Here

1205

1197

1206

1198

1207

1199

1208

///

1209

/// \brief Processes a HELLO message following \RFC{3626} specification.

1210

///

1211

/// Link sensing and population of the Neighbor Set, 2-hop Neighbor Set and MPR

1212

/// Selector Set are performed.

1213

///

1214

/// \param msg the %OLSR message which contains the HELLO message.

1215

/// \param receiver_iface the address of the interface where the message was received from.

1216

/// \param sender_iface the address of the interface where the message was sent from.

1217

///

1218

void

1200

void

1219

RoutingProtocol::ProcessHello (const olsr::MessageHeader &msg,

1201

RoutingProtocol::ProcessHello (const olsr::MessageHeader &msg,

1220

                               const Ipv4Address &receiverIface,

1202

                               const Ipv4Address &receiverIface,

Lines 1269-1283	Link Here

1269

  PopulateMprSelectorSet (msg, hello);

1251

  PopulateMprSelectorSet (msg, hello);

1270

1252

1271

1253

1272

///

1273

/// \brief Processes a TC message following \RFC{3626} specification.

1274

///

1275

/// The Topology Set is updated (if needed) with the information of

1276

/// the received TC message.

1277

///

1278

/// \param msg the %OLSR message which contains the TC message.

1279

/// \param sender_iface the address of the interface where the message was sent from.

1280

///

1281

void

1254

void

1282

RoutingProtocol::ProcessTc (const olsr::MessageHeader &msg,

1255

RoutingProtocol::ProcessTc (const olsr::MessageHeader &msg,

1283

                            const Ipv4Address &senderIface)

1256

                            const Ipv4Address &senderIface)

Lines 1364-1378	Link Here

1364

#endif // NS3_LOG_ENABLE

1337

#endif // NS3_LOG_ENABLE

1365

1338

1366

1339

1367

///

1368

/// \brief Processes a MID message following \RFC{3626} specification.

1369

///

1370

/// The Interface Association Set is updated (if needed) with the information

1371

/// of the received MID message.

1372

///

1373

/// \param msg the %OLSR message which contains the MID message.

1374

/// \param sender_iface the address of the interface where the message was sent from.

1375

///

1376

void

1340

void

1377

RoutingProtocol::ProcessMid (const olsr::MessageHeader &msg,

1341

RoutingProtocol::ProcessMid (const olsr::MessageHeader &msg,

1378

                             const Ipv4Address &senderIface)

1342

                             const Ipv4Address &senderIface)

Lines 1443-1457	Link Here

1443

  NS_LOG_DEBUG ("Node " << m_mainAddress << " ProcessMid from " << senderIface << " -> END.");

1407

  NS_LOG_DEBUG ("Node " << m_mainAddress << " ProcessMid from " << senderIface << " -> END.");

1444

1408

1445

1409

1446

///

1447

/// \brief Processes a HNA message following \RFC{3626} specification.

1448

///

1449

/// The Host Network Association Set is updated (if needed) with the information

1450

/// of the received HNA message.

1451

///

1452

/// \param msg the %OLSR message which contains the HNA message.

1453

/// \param sender_iface the address of the interface where the message was sent from.

1454

///

1455

void

1410

void

1456

RoutingProtocol::ProcessHna (const olsr::MessageHeader &msg,

1411

RoutingProtocol::ProcessHna (const olsr::MessageHeader &msg,

1457

                             const Ipv4Address &senderIface)

1412

                             const Ipv4Address &senderIface)

Lines 1509-1525	Link Here

1509

1464

1510

1465

1511

1466

1512

///

1513

/// \brief OLSR's default forwarding algorithm.

1514

///

1515

/// See \RFC{3626} for details.

1516

///

1517

/// \param p the %OLSR packet which has been received.

1518

/// \param msg the %OLSR message which must be forwarded.

1519

/// \param dup_tuple NULL if the message has never been considered for forwarding,

1520

/// or a duplicate tuple in other case.

1521

/// \param local_iface the address of the interface where the message was received from.

1522

///

1523

void

1467

void

1524

RoutingProtocol::ForwardDefault (olsr::MessageHeader olsrMessage,

1468

RoutingProtocol::ForwardDefault (olsr::MessageHeader olsrMessage,

1525

                                 DuplicateTuple *duplicated,

1469

                                 DuplicateTuple *duplicated,

Lines 1586-1600	Link Here

1586

1530

1587

1531

1588

1532

1589

///

1590

/// \brief Enques an %OLSR message which will be sent with a delay of (0, delay].

1591

///

1592

/// This buffering system is used in order to piggyback several %OLSR messages in

1593

/// a same %OLSR packet.

1594

///

1595

/// \param msg the %OLSR message which must be sent.

1596

/// \param delay maximum delay the %OLSR message is going to be buffered.

1597

///

1598

void

1533

void

1599

RoutingProtocol::QueueMessage (const olsr::MessageHeader &message, Time delay)

1534

RoutingProtocol::QueueMessage (const olsr::MessageHeader &message, Time delay)

1600

1535

Lines 1630-1642	Link Here

1630

1565

1631

1566

1632

1567

1633

///

1634

/// \brief Creates as many %OLSR packets as needed in order to send all buffered

1635

/// %OLSR messages.

1636

///

1637

/// Maximum number of messages which can be contained in an %OLSR packet is

1638

/// dictated by OLSR_MAX_MSGS constant.

1639

///

1640

void

1568

void

1641

RoutingProtocol::SendQueuedMessages ()

1569

RoutingProtocol::SendQueuedMessages ()

1642

1570

Lines 1673-1681	Link Here

1673

  m_queuedMessages.clear ();

1601

  m_queuedMessages.clear ();

1674

1602

1675

1603

1676

///

1677

/// \brief Creates a new %OLSR HELLO message which is buffered for being sent later on.

1678

///

1679

void

1604

void

1680

RoutingProtocol::SendHello ()

1605

RoutingProtocol::SendHello ()

1681

1606

Lines 1784-1792	Link Here

1784

  QueueMessage (msg, JITTER);

1709

  QueueMessage (msg, JITTER);

1785

1710

1786

1711

1787

///

1788

/// \brief Creates a new %OLSR TC message which is buffered for being sent later on.

1789

///

1790

void

1712

void

1791

RoutingProtocol::SendTc ()

1713

RoutingProtocol::SendTc ()

1792

1714

Lines 1811-1819	Link Here

1811

  QueueMessage (msg, JITTER);

1733

  QueueMessage (msg, JITTER);

1812

1734

1813

1735

1814

///

1815

/// \brief Creates a new %OLSR MID message which is buffered for being sent later on.

1816

///

1817

void

1736

void

1818

RoutingProtocol::SendMid ()

1737

RoutingProtocol::SendMid ()

1819

1738

Lines 1855-1863	Link Here

1855

  QueueMessage (msg, JITTER);

1774

  QueueMessage (msg, JITTER);

1856

1775

1857

1776

1858

///

1859

/// \brief Creates a new %OLSR HNA message which is buffered for being sent later on.

1860

///

1861

void

1777

void

1862

RoutingProtocol::SendHna ()

1778

RoutingProtocol::SendHna ()

1863

1779

Lines 1891-1901	Link Here

1891

  QueueMessage (msg, JITTER);

1807

  QueueMessage (msg, JITTER);

1892

1808

1893

1809

1894

///

1895

/// \brief Injects the specified (networkAddr, netmask) tuple in the list of

1896

///        local HNA associations to be sent by the node via HNA messages.

1897

///        If this tuple already exists, nothing is done.

1898

///

1899

void

1810

void

1900

RoutingProtocol::AddHostNetworkAssociation (Ipv4Address networkAddr, Ipv4Mask netmask)

1811

RoutingProtocol::AddHostNetworkAssociation (Ipv4Address networkAddr, Ipv4Mask netmask)

1901

1812

Lines 1917-1927	Link Here

1917

  m_state.InsertAssociation ( (Association) { networkAddr, netmask} );

1828

  m_state.InsertAssociation ( (Association) { networkAddr, netmask} );

1918

1829

1919

1830

1920

///

1921

/// \brief Removes the specified (networkAddr, netmask) tuple from the list of

1922

///        local HNA associations to be sent by the node via HNA messages.

1923

///        If this tuple does not exist, nothing is done (see "OlsrState::EraseAssociation()").

1924

///

1925

void

1831

void

1926

RoutingProtocol::RemoveHostNetworkAssociation (Ipv4Address networkAddr, Ipv4Mask netmask)

1832

RoutingProtocol::RemoveHostNetworkAssociation (Ipv4Address networkAddr, Ipv4Mask netmask)

1927

1833

Lines 1929-1944	Link Here

1929

  m_state.EraseAssociation ( (Association) { networkAddr, netmask} );

1835

  m_state.EraseAssociation ( (Association) { networkAddr, netmask} );

1930

1836

1931

1837

1932

///

1933

/// \brief Associates the specified Ipv4StaticRouting routing table

1934

///        to the OLSR routing protocol. Entries from this associated

1935

///        routing table that use non-olsr outgoing interfaces are added

1936

///        to the list of local HNA associations so that they are included

1937

///        in HNA messages sent by the node.

1938

///        If this method is called more than once, entries from the old

1939

///        association are deleted before entries from the new one are added.

1940

/// \param routingTable the Ipv4StaticRouting routing table to be associated.

1941

///

1942

void

1838

void

1943

RoutingProtocol::SetRoutingTableAssociation (Ptr<Ipv4StaticRouting> routingTable)

1839

RoutingProtocol::SetRoutingTableAssociation (Ptr<Ipv4StaticRouting> routingTable)

1944

1840

Lines 1984-1994	Link Here

1984

                "the associated routing table: " << m_state.GetAssociations ().size ());

1880

                "the associated routing table: " << m_state.GetAssociations ().size ());

1985

1881

1986

1882

1987

///

1988

/// \brief Tests whether or not the specified route uses a non-OLSR outgoing interface.

1989

///        Returns true if the outgoing interface of the specified route is a non-OLSR interface.

1990

///        Returns false otherwise.

1991

///

1992

bool

1883

bool

1993

RoutingProtocol::UsesNonOlsrOutgoingInterface (const Ipv4RoutingTableEntry &route)

1884

RoutingProtocol::UsesNonOlsrOutgoingInterface (const Ipv4RoutingTableEntry &route)

1994

1885

Lines 1998-2006	Link Here

1998

  return ci != m_interfaceExclusions.end ();

1889

  return ci != m_interfaceExclusions.end ();

1999

1890

2000

1891

2001

///

2002

/// \brief Updates Link Set according to a new received HELLO message

2003

/// (following \RFC{3626} specification). Neighbor Set is also updated if needed.

2004

void

1892

void

2005

RoutingProtocol::LinkSensing (const olsr::MessageHeader &msg,

1893

RoutingProtocol::LinkSensing (const olsr::MessageHeader &msg,

2006

                              const olsr::MessageHeader::Hello &hello,

1894

                              const olsr::MessageHeader::Hello &hello,

Lines 2135-2143	Link Here

2135

                    << ": LinkSensing END");

2023

                    << ": LinkSensing END");

2136

2024

2137

2025

2138

///

2139

/// \brief Updates the Neighbor Set according to the information contained in

2140

/// a new received HELLO message (following \RFC{3626}).

2141

void

2026

void

2142

RoutingProtocol::PopulateNeighborSet (const olsr::MessageHeader &msg,

2027

RoutingProtocol::PopulateNeighborSet (const olsr::MessageHeader &msg,

2143

                                      const olsr::MessageHeader::Hello &hello)

2028

                                      const olsr::MessageHeader::Hello &hello)

Lines 2149-2158	Link Here

2149

2034

2150

2035

2151

2036

2152

2153

///

2154

/// \brief Updates the 2-hop Neighbor Set according to the information contained

2155

/// in a new received HELLO message (following \RFC{3626}).

2156

void

2037

void

2157

RoutingProtocol::PopulateTwoHopNeighborSet (const olsr::MessageHeader &msg,

2038

RoutingProtocol::PopulateTwoHopNeighborSet (const olsr::MessageHeader &msg,

2158

                                            const olsr::MessageHeader::Hello &hello)

2039

                                            const olsr::MessageHeader::Hello &hello)

Lines 2260-2270	Link Here

2260

  NS_LOG_DEBUG ("Olsr node " << m_mainAddress << ": PopulateTwoHopNeighborSet END");

2141

  NS_LOG_DEBUG ("Olsr node " << m_mainAddress << ": PopulateTwoHopNeighborSet END");

2261

2142

2262

2143

2263

2264

2265

///

2266

/// \brief Updates the MPR Selector Set according to the information contained in

2267

/// a new received HELLO message (following \RFC{3626}).

2268

void

2144

void

2269

RoutingProtocol::PopulateMprSelectorSet (const olsr::MessageHeader &msg,

2145

RoutingProtocol::PopulateMprSelectorSet (const olsr::MessageHeader &msg,

2270

                                         const olsr::MessageHeader::Hello &hello)

2146

                                         const olsr::MessageHeader::Hello &hello)

Lines 2324-2330	Link Here

2324

#if 0

2200

#if 0

2325

///

2201

///

2326

/// \brief Drops a given packet because it couldn't be delivered to the corresponding

2202

/// \brief Drops a given packet because it couldn't be delivered to the corresponding

2327

/// destination by the MAC layer. This may cause a neighbor loss, and appropiate

2203

/// destination by the MAC layer. This may cause a neighbor loss, and appropriate

2328

/// actions are then taken.

2204

/// actions are then taken.

2329

///

2205

///

2330

/// \param p the packet which couldn't be delivered by the MAC layer.

2206

/// \param p the packet which couldn't be delivered by the MAC layer.

Lines 2358-2370	Link Here

2358

2234

2359

2235

2360

2236

2361

///

2362

/// \brief Performs all actions needed when a neighbor loss occurs.

2363

///

2364

/// Neighbor Set, 2-hop Neighbor Set, MPR Set and MPR Selector Set are updated.

2365

///

2366

/// \param tuple link tuple with the information of the link to the neighbor which has been lost.

2367

///

2368

void

2237

void

2369

RoutingProtocol::NeighborLoss (const LinkTuple &tuple)

2238

RoutingProtocol::NeighborLoss (const LinkTuple &tuple)

2370

2239

Lines 2379-2389	Link Here

2379

  RoutingTableComputation ();

2248

  RoutingTableComputation ();

2380

2249

2381

2250

2382

///

2383

/// \brief Adds a duplicate tuple to the Duplicate Set.

2384

///

2385

/// \param tuple the duplicate tuple to be added.

2386

///

2387

void

2251

void

2388

RoutingProtocol::AddDuplicateTuple (const DuplicateTuple &tuple)

2252

RoutingProtocol::AddDuplicateTuple (const DuplicateTuple &tuple)

2389

2253

Lines 2395-2405	Link Here

2395

  m_state.InsertDuplicateTuple (tuple);

2259

  m_state.InsertDuplicateTuple (tuple);

2396

2260

2397

2261

2398

///

2399

/// \brief Removes a duplicate tuple from the Duplicate Set.

2400

///

2401

/// \param tuple the duplicate tuple to be removed.

2402

///

2403

void

2262

void

2404

RoutingProtocol::RemoveDuplicateTuple (const DuplicateTuple &tuple)

2263

RoutingProtocol::RemoveDuplicateTuple (const DuplicateTuple &tuple)

2405

2264

Lines 2431-2441	Link Here

2431

  AddNeighborTuple (nb_tuple);

2290

  AddNeighborTuple (nb_tuple);

2432

2291

2433

2292

2434

///

2435

/// \brief Removes a link tuple from the Link Set.

2436

///

2437

/// \param tuple the link tuple to be removed.

2438

///

2439

void

2293

void

2440

RoutingProtocol::RemoveLinkTuple (const LinkTuple &tuple)

2294

RoutingProtocol::RemoveLinkTuple (const LinkTuple &tuple)

2441

2295

Lines 2447-2458	Link Here

2447

  m_state.EraseLinkTuple (tuple);

2301

  m_state.EraseLinkTuple (tuple);

2448

2302

2449

2303

2450

///

2451

/// \brief This function is invoked when a link tuple is updated. Its aim is to

2452

/// also update the corresponding neighbor tuple if it is needed.

2453

///

2454

/// \param tuple the link tuple which has been updated.

2455

///

2456

void

2304

void

2457

RoutingProtocol::LinkTupleUpdated (const LinkTuple &tuple, uint8_t willingness)

2305

RoutingProtocol::LinkTupleUpdated (const LinkTuple &tuple, uint8_t willingness)

2458

2306

Lines 2509-2519	Link Here

2509

2357

2510

2358

2511

2359

2512

///

2513

/// \brief Adds a neighbor tuple to the Neighbor Set.

2514

///

2515

/// \param tuple the neighbor tuple to be added.

2516

///

2517

void

2360

void

2518

RoutingProtocol::AddNeighborTuple (const NeighborTuple &tuple)

2361

RoutingProtocol::AddNeighborTuple (const NeighborTuple &tuple)

2519

2362

Lines 2527-2537	Link Here

2527

  IncrementAnsn ();

2370

  IncrementAnsn ();

2528

2371

2529

2372

2530

///

2531

/// \brief Removes a neighbor tuple from the Neighbor Set.

2532

///

2533

/// \param tuple the neighbor tuple to be removed.

2534

///

2535

void

2373

void

2536

RoutingProtocol::RemoveNeighborTuple (const NeighborTuple &tuple)

2374

RoutingProtocol::RemoveNeighborTuple (const NeighborTuple &tuple)

2537

2375

Lines 2545-2555	Link Here

2545

  IncrementAnsn ();

2383

  IncrementAnsn ();

2546

2384

2547

2385

2548

///

2549

/// \brief Adds a 2-hop neighbor tuple to the 2-hop Neighbor Set.

2550

///

2551

/// \param tuple the 2-hop neighbor tuple to be added.

2552

///

2553

void

2386

void

2554

RoutingProtocol::AddTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple)

2387

RoutingProtocol::AddTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple)

2555

2388

Lines 2562-2572	Link Here

2562

  m_state.InsertTwoHopNeighborTuple (tuple);

2395

  m_state.InsertTwoHopNeighborTuple (tuple);

2563

2396

2564

2397

2565

///

2566

/// \brief Removes a 2-hop neighbor tuple from the 2-hop Neighbor Set.

2567

///

2568

/// \param tuple the 2-hop neighbor tuple to be removed.

2569

///

2570

void

2398

void

2571

RoutingProtocol::RemoveTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple)

2399

RoutingProtocol::RemoveTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple)

2572

2400

Lines 2585-2597	Link Here

2585

  m_ansn = (m_ansn + 1) % (OLSR_MAX_SEQ_NUM + 1);

2413

  m_ansn = (m_ansn + 1) % (OLSR_MAX_SEQ_NUM + 1);

2586

2414

2587

2415

2588

///

2589

/// \brief Adds an MPR selector tuple to the MPR Selector Set.

2590

///

2591

/// Advertised Neighbor Sequence Number (ANSN) is also updated.

2592

///

2593

/// \param tuple the MPR selector tuple to be added.

2594

///

2595

void

2416

void

2596

RoutingProtocol::AddMprSelectorTuple (const MprSelectorTuple  &tuple)

2417

RoutingProtocol::AddMprSelectorTuple (const MprSelectorTuple  &tuple)

2597

2418

Lines 2604-2616	Link Here

2604

  IncrementAnsn ();

2425

  IncrementAnsn ();

2605

2426

2606

2427

2607

///

2608

/// \brief Removes an MPR selector tuple from the MPR Selector Set.

2609

///

2610

/// Advertised Neighbor Sequence Number (ANSN) is also updated.

2611

///

2612

/// \param tuple the MPR selector tuple to be removed.

2613

///

2614

void

2428

void

2615

RoutingProtocol::RemoveMprSelectorTuple (const MprSelectorTuple &tuple)

2429

RoutingProtocol::RemoveMprSelectorTuple (const MprSelectorTuple &tuple)

2616

2430

Lines 2623-2633	Link Here

2623

  IncrementAnsn ();

2437

  IncrementAnsn ();

2624

2438

2625

2439

2626

///

2627

/// \brief Adds a topology tuple to the Topology Set.

2628

///

2629

/// \param tuple the topology tuple to be added.

2630

///

2631

void

2440

void

2632

RoutingProtocol::AddTopologyTuple (const TopologyTuple &tuple)

2441

RoutingProtocol::AddTopologyTuple (const TopologyTuple &tuple)

2633

2442

Lines 2641-2651	Link Here

2641

  m_state.InsertTopologyTuple (tuple);

2450

  m_state.InsertTopologyTuple (tuple);

2642

2451

2643

2452

2644

///

2645

/// \brief Removes a topology tuple from the Topology Set.

2646

///

2647

/// \param tuple the topology tuple to be removed.

2648

///

2649

void

2453

void

2650

RoutingProtocol::RemoveTopologyTuple (const TopologyTuple &tuple)

2454

RoutingProtocol::RemoveTopologyTuple (const TopologyTuple &tuple)

2651

2455

Lines 2659-2669	Link Here

2659

  m_state.EraseTopologyTuple (tuple);

2463

  m_state.EraseTopologyTuple (tuple);

2660

2464

2661

2465

2662

///

2663

/// \brief Adds an interface association tuple to the Interface Association Set.

2664

///

2665

/// \param tuple the interface association tuple to be added.

2666

///

2667

void

2466

void

2668

RoutingProtocol::AddIfaceAssocTuple (const IfaceAssocTuple &tuple)

2467

RoutingProtocol::AddIfaceAssocTuple (const IfaceAssocTuple &tuple)

2669

2468

Lines 2676-2686	Link Here

2676

  m_state.InsertIfaceAssocTuple (tuple);

2475

  m_state.InsertIfaceAssocTuple (tuple);

2677

2476

2678

2477

2679

///

2680

/// \brief Removes an interface association tuple from the Interface Association Set.

2681

///

2682

/// \param tuple the interface association tuple to be removed.

2683

///

2684

void

2478

void

2685

RoutingProtocol::RemoveIfaceAssocTuple (const IfaceAssocTuple &tuple)

2479

RoutingProtocol::RemoveIfaceAssocTuple (const IfaceAssocTuple &tuple)

2686

2480

Lines 2693-2740	Link Here

2693

  m_state.EraseIfaceAssocTuple (tuple);

2487

  m_state.EraseIfaceAssocTuple (tuple);

2694

2488

2695

2489

2696

///

2697

/// \brief Adds a host network association tuple to the Association Set.

2698

///

2699

/// \param tuple the host network association tuple to be added.

2700

///

2701

void

2490

void

2702

RoutingProtocol::AddAssociationTuple (const AssociationTuple &tuple)

2491

RoutingProtocol::AddAssociationTuple (const AssociationTuple &tuple)

2703

2492

2704

  m_state.InsertAssociationTuple (tuple);

2493

  m_state.InsertAssociationTuple (tuple);

2705

2494

2706

2495

2707

///

2708

/// \brief Removes a host network association tuple from the Association Set.

2709

///

2710

/// \param tuple the host network association tuple to be removed.

2711

///

2712

void

2496

void

2713

RoutingProtocol::RemoveAssociationTuple (const AssociationTuple &tuple)

2497

RoutingProtocol::RemoveAssociationTuple (const AssociationTuple &tuple)

2714

2498

2715

  m_state.EraseAssociationTuple (tuple);

2499

  m_state.EraseAssociationTuple (tuple);

2716

2500

2717

2501

2718

2719

2720

uint16_t RoutingProtocol::GetPacketSequenceNumber ()

2502

uint16_t RoutingProtocol::GetPacketSequenceNumber ()

2721

2503

2722

  m_packetSequenceNumber = (m_packetSequenceNumber + 1) % (OLSR_MAX_SEQ_NUM + 1);

2504

  m_packetSequenceNumber = (m_packetSequenceNumber + 1) % (OLSR_MAX_SEQ_NUM + 1);

2723

  return m_packetSequenceNumber;

2505

  return m_packetSequenceNumber;

2724

2506

2725

2507

2726

/// Increments message sequence number and returns the new value.

2727

uint16_t RoutingProtocol::GetMessageSequenceNumber ()

2508

uint16_t RoutingProtocol::GetMessageSequenceNumber ()

2728

2509

2729

  m_messageSequenceNumber = (m_messageSequenceNumber + 1) % (OLSR_MAX_SEQ_NUM + 1);

2510

  m_messageSequenceNumber = (m_messageSequenceNumber + 1) % (OLSR_MAX_SEQ_NUM + 1);

2730

  return m_messageSequenceNumber;

2511

  return m_messageSequenceNumber;

2731

2512

2732

2513

2733

2734

///

2735

/// \brief Sends a HELLO message and reschedules the HELLO timer.

2736

/// \param e The event which has expired.

2737

///

2738

void

2514

void

2739

RoutingProtocol::HelloTimerExpire ()

2515

RoutingProtocol::HelloTimerExpire ()

2740

2516

Lines 2742-2751	Link Here

2742

  m_helloTimer.Schedule (m_helloInterval);

2518

  m_helloTimer.Schedule (m_helloInterval);

2743

2519

2744

2520

2745

///

2746

/// \brief Sends a TC message (if there exists any MPR selector) and reschedules the TC timer.

2747

/// \param e The event which has expired.

2748

///

2749

void

2521

void

2750

RoutingProtocol::TcTimerExpire ()

2522

RoutingProtocol::TcTimerExpire ()

2751

2523

Lines 2760-2769	Link Here

2760

  m_tcTimer.Schedule (m_tcInterval);

2532

  m_tcTimer.Schedule (m_tcInterval);

2761

2533

2762

2534

2763

///

2764

/// \brief Sends a MID message (if the node has more than one interface) and resets the MID timer.

2765

/// \param e The event which has expired.

2766

///

2767

void

2535

void

2768

RoutingProtocol::MidTimerExpire ()

2536

RoutingProtocol::MidTimerExpire ()

2769

2537

Lines 2771-2779	Link Here

2771

  m_midTimer.Schedule (m_midInterval);

2539

  m_midTimer.Schedule (m_midInterval);

2772

2540

2773

2541

2774

///

2775

/// \brief Sends an HNA message (if the node has associated hosts/networks) and reschedules the HNA timer.

2776

///

2777

void

2542

void

2778

RoutingProtocol::HnaTimerExpire ()

2543

RoutingProtocol::HnaTimerExpire ()

2779

2544

Lines 2788-2800	Link Here

2788

  m_hnaTimer.Schedule (m_hnaInterval);

2553

  m_hnaTimer.Schedule (m_hnaInterval);

2789

2554

2790

2555

2791

///

2792

/// \brief Removes tuple if expired. Else timer is rescheduled to expire at tuple.expirationTime.

2793

///

2794

/// The task of actually removing the tuple is left to the OLSR agent.

2795

///

2796

/// \param tuple The tuple which has expired.

2797

///

2798

void

2556

void

2799

RoutingProtocol::DupTupleTimerExpire (Ipv4Address address, uint16_t sequenceNumber)

2557

RoutingProtocol::DupTupleTimerExpire (Ipv4Address address, uint16_t sequenceNumber)

2800

2558

Lines 2816-2832	Link Here

2816

2574

2817

2575

2818

2576

2819

///

2820

/// \brief Removes tuple_ if expired. Else if symmetric time

2821

/// has expired then it is assumed a neighbor loss and agent_->nb_loss()

2822

/// is called. In this case the timer is rescheduled to expire at

2823

/// tuple_->time(). Otherwise the timer is rescheduled to expire at

2824

/// the minimum between tuple_->time() and tuple_->sym_time().

2825

///

2826

/// The task of actually removing the tuple is left to the OLSR agent.

2827

///

2828

/// \param e The event which has expired.

2829

///

2830

void

2577

void

2831

RoutingProtocol::LinkTupleTimerExpire (Ipv4Address neighborIfaceAddr)

2578

RoutingProtocol::LinkTupleTimerExpire (Ipv4Address neighborIfaceAddr)

2832

2579

Lines 2861-2873	Link Here

2861

2608

2862

2609

2863

2610

2864

///

2865

/// \brief Removes tuple_ if expired. Else the timer is rescheduled to expire at tuple_->time().

2866

///

2867

/// The task of actually removing the tuple is left to the OLSR agent.

2868

///

2869

/// \param e The event which has expired.

2870

///

2871

void

2611

void

2872

RoutingProtocol::Nb2hopTupleTimerExpire (Ipv4Address neighborMainAddr, Ipv4Address twoHopNeighborAddr)

2612

RoutingProtocol::Nb2hopTupleTimerExpire (Ipv4Address neighborMainAddr, Ipv4Address twoHopNeighborAddr)

2873

2613

Lines 2889-2901	Link Here

2889

2629

2890

2630

2891

2631

2892

///

2893

/// \brief Removes tuple_ if expired. Else the timer is rescheduled to expire at tuple_->time().

2894

///

2895

/// The task of actually removing the tuple is left to the OLSR agent.

2896

///

2897

/// \param e The event which has expired.

2898

///

2899

void

2632

void

2900

RoutingProtocol::MprSelTupleTimerExpire (Ipv4Address mainAddr)

2633

RoutingProtocol::MprSelTupleTimerExpire (Ipv4Address mainAddr)

2901

2634

Lines 2916-2928	Link Here

2916

2649

2917

2650

2918

2651

2919

///

2920

/// \brief Removes tuple_ if expired. Else the timer is rescheduled to expire at tuple_->time().

2921

///

2922

/// The task of actually removing the tuple is left to the OLSR agent.

2923

///

2924

/// \param e The event which has expired.

2925

///

2926

void

2652

void

2927

RoutingProtocol::TopologyTupleTimerExpire (Ipv4Address destAddr, Ipv4Address lastAddr)

2653

RoutingProtocol::TopologyTupleTimerExpire (Ipv4Address destAddr, Ipv4Address lastAddr)

2928

2654

Lines 2943-2952	Link Here

2943

2669

2944

2670

2945

2671

2946

///

2947

/// \brief Removes tuple_ if expired. Else timer is rescheduled to expire at tuple_->time().

2948

/// \param e The event which has expired.

2949

///

2950

void

2672

void

2951

RoutingProtocol::IfaceAssocTupleTimerExpire (Ipv4Address ifaceAddr)

2673

RoutingProtocol::IfaceAssocTupleTimerExpire (Ipv4Address ifaceAddr)

2952

2674

Lines 2967-2975	Link Here

2967

2689

2968

2690

2969

2691

2970

/// \brief Removes tuple_ if expired. Else timer is rescheduled to expire at tuple_->time().

2971

/// \param e The event which has expired.

2972

///

2973

void

2692

void

2974

RoutingProtocol::AssociationTupleTimerExpire (Ipv4Address gatewayAddr, Ipv4Address networkAddr, Ipv4Mask netmask)

2693

RoutingProtocol::AssociationTupleTimerExpire (Ipv4Address gatewayAddr, Ipv4Address networkAddr, Ipv4Mask netmask)

2975

2694

Lines 2990-2998	Link Here

2990

2709

2991

2710

2992

2711

2993

///

2994

/// \brief Clears the routing table and frees the memory assigned to each one of its entries.

2995

///

2996

void

2712

void

2997

RoutingProtocol::Clear ()

2713

RoutingProtocol::Clear ()

2998

2714

Lines 3000-3021	Link Here

3000

  m_table.clear ();

2716

  m_table.clear ();

3001

2717

3002

2718

3003

///

3004

/// \brief Deletes the entry whose destination address is given.

3005

/// \param dest address of the destination node.

3006

///

3007

void

2719

void

3008

RoutingProtocol::RemoveEntry (Ipv4Address const &dest)

2720

RoutingProtocol::RemoveEntry (Ipv4Address const &dest)

3009

2721

3010

  m_table.erase (dest);

2722

  m_table.erase (dest);

3011

2723

3012

2724

3013

///

3014

/// \brief Looks up an entry for the specified destination address.

3015

/// \param dest destination address.

3016

/// \param outEntry output parameter to hold the routing entry result, if fuond

3017

/// \return true if found, false if not found

3018

///

3019

bool

2725

bool

3020

RoutingProtocol::Lookup (Ipv4Address const &dest,

2726

RoutingProtocol::Lookup (Ipv4Address const &dest,

3021

                         RoutingTableEntry &outEntry) const

2727

                         RoutingTableEntry &outEntry) const

Lines 3030-3051	Link Here

3030

  return true;

2736

  return true;

3031

2737

3032

2738

3033

///

3034

/// \brief Finds the appropiate entry which must be used in order to forward

3035

/// a data packet to a next hop (given a destination).

3036

///

3037

/// Imagine a routing table like this: [A,B] [B,C] [C,C]; being each pair of the

3038

/// form [dest addr,next-hop addr]. In this case, if this function is invoked with

3039

/// [A,B] then pair [C,C] is returned because C is the next hop that must be used

3040

/// to forward a data packet destined to A. That is, C is a neighbor of this node,

3041

/// but B isn't. This function finds the appropiate neighbor for forwarding a packet.

3042

///

3043

/// \param entry the routing table entry which indicates the destination node

3044

/// we are interested in.

3045

/// \return the appropiate routing table entry which indicates the next

3046

/// hop which must be used for forwarding a data packet, or NULL

3047

/// if there is no such entry.

3048

///

3049

bool

2739

bool

3050

RoutingProtocol::FindSendEntry (RoutingTableEntry const &entry,

2740

RoutingProtocol::FindSendEntry (RoutingTableEntry const &entry,

3051

                                RoutingTableEntry &outEntry) const

2741

                                RoutingTableEntry &outEntry) const

Lines 3251-3266	Link Here

3251

{}

2941

{}

3252

2942

3253

2943

3254

///

3255

/// \brief Adds a new entry into the routing table.

3256

///

3257

/// If an entry for the given destination existed, it is deleted and freed.

3258

///

3259

/// \param dest address of the destination node.

3260

/// \param next address of the next hop node.

3261

/// \param iface address of the local interface.

3262

/// \param dist distance to the destination node.

3263

///

3264

void

2944

void

3265

RoutingProtocol::AddEntry (Ipv4Address const &dest,

2945

RoutingProtocol::AddEntry (Ipv4Address const &dest,

3266

                           Ipv4Address const &next,

2946

                           Ipv4Address const &next,




/// This section documents the API of the ns-3 OLSR module. For a generic 
/// functional description, please refer to the ns-3 manual.

/// \ingroup olsr
/// An %OLSR's routing table entry.
struct RoutingTableEntry
{
  Ipv4Address destAddr; //!< Address of the destination node.
  Ipv4Address nextAddr; //!< Address of the next hop.
  uint32_t interface; //!< Interface index
  uint32_t distance; //!< Distance in hops to the destination.

  RoutingTableEntry () : // default values
                         destAddr (), nextAddr (),

{
public:
  friend class ::OlsrMprTestCase;

  /**
   * \brief Get the type ID.
   * \return The object TypeId.
   */
  static TypeId GetTypeId (void);

  RoutingProtocol ();
  virtual ~RoutingProtocol ();

  /**
   * \brief Set the OLSR main address to the first address on the indicated interface.
   *
   * \param interface IPv4 interface index
   */
  void SetMainInterface (uint32_t interface);

  /**
   * Dump the neighbor table, two-hop neighbor table, and routing table
   * to logging output (NS_LOG_DEBUG log level).  If logging is disabled,
   * this function does nothing.
   */
  void Dump (void);

  /**
   * Return the list of routing table entries discovered by OLSR
   */
  std::vector<RoutingTableEntry> GetRoutingTableEntries () const;

 /**

  typedef void (* TableChangeTracedCallback) (uint32_t size);

private:
  std::set<uint32_t> m_interfaceExclusions; //!< Set of interfaces excluded by OSLR.
  Ptr<Ipv4StaticRouting> m_routingTableAssociation; //!< Associations from an Ipv4StaticRouting instance

public:
  /**
   * Get the excluded interfaces.
   * \returns Container of excluded interfaces.
   */
  std::set<uint32_t> GetInterfaceExclusions () const
  {
    return m_interfaceExclusions;
  }

  /**
   * Set the interfaces to be excluded.
   * \param exceptions Container of excluded interfaces.
   */
  void SetInterfaceExclusions (std::set<uint32_t> exceptions);

  /**
   *  \brief Injects the specified (networkAddr, netmask) tuple in the list of
   *  local HNA associations to be sent by the node via HNA messages.
   *  If this tuple already exists, nothing is done.
   *
   * \param networkAddr The network address.
   * \param netmask The network mask.
   */
  void AddHostNetworkAssociation (Ipv4Address networkAddr, Ipv4Mask netmask);

  /**
   * \brief Removes the specified (networkAddr, netmask) tuple from the list of
   * local HNA associations to be sent by the node via HNA messages.
   * If this tuple does not exist, nothing is done (see "OlsrState::EraseAssociation()").
   *
   * \param networkAddr The network address.
   * \param netmask The network mask.
   */
  void RemoveHostNetworkAssociation (Ipv4Address networkAddr, Ipv4Mask netmask);

  /**
   * \brief Associates the specified Ipv4StaticRouting routing table
   *         to the OLSR routing protocol. Entries from this associated
   *         routing table that use non-olsr outgoing interfaces are added
   *         to the list of local HNA associations so that they are included
   *         in HNA messages sent by the node.
   *         If this method is called more than once, entries from the old
   *         association are deleted before entries from the new one are added.
   *  \param routingTable the Ipv4StaticRouting routing table to be associated.
   */
  void SetRoutingTableAssociation (Ptr<Ipv4StaticRouting> routingTable);

  /**

protected:
  virtual void DoInitialize (void);
private:
  std::map<Ipv4Address, RoutingTableEntry> m_table; //!< Data structure for the routing table.

  Ptr<Ipv4StaticRouting> m_hnaRoutingTable; //!< Routing table for HNA routes

  EventGarbageCollector m_events; //!< Running events.
	
  uint16_t m_packetSequenceNumber;    //!< Packets sequence number counter.
  uint16_t m_messageSequenceNumber;   //!< Messages sequence number counter.
  uint16_t m_ansn;  //!< Advertised Neighbor Set sequence number.
  uint16_t m_messageSequenceNumber;
  /// Advertised Neighbor Set sequence number.
  uint16_t m_ansn;

  Time m_helloInterval;   //!< HELLO messages' emission interval.
  Time m_tcInterval;      //!< TC messages' emission interval.
  Time m_midInterval;     //!< MID messages' emission interval.
  Time m_hnaInterval;     //!< HNA messages' emission interval.
  uint8_t m_willingness;  //!<  Willingness for forwarding packets on behalf of other nodes.
  Time m_midInterval;
  /// HNA messages' emission interval.
  Time m_hnaInterval;
  /// Willingness for forwarding packets on behalf of other nodes.
  uint8_t m_willingness;

  OlsrState m_state;  //!< Internal state with all needed data structs.
  Ptr<Ipv4> m_ipv4;   //!< IPv4 object the routing is linked to.

  /**
   * \brief Clears the routing table and frees the memory assigned to each one of its entries.
   */
  void Clear ();

  /**
   * Returns the routing table size.
   * \return The routing table size.
   */
  uint32_t GetSize () const { return m_table.size (); }

  /**
   * \brief Deletes the entry whose destination address is given.
   * \param dest address of the destination node.
   */
  void RemoveEntry (const Ipv4Address &dest);
  /**
   * \brief Adds a new entry into the routing table.
   *
   * If an entry for the given destination existed, it is deleted and freed.
   *
   * \param dest address of the destination node.
   * \param next address of the next hop node.
   * \param interface address of the local interface.
   * \param distance distance to the destination node.
   */
  void AddEntry (const Ipv4Address &dest,
                 const Ipv4Address &next,
                 uint32_t interface,
                 uint32_t distance);
  /**
   * \brief Adds a new entry into the routing table.
   *
   * If an entry for the given destination existed, an error is thrown.
   *
   * \param dest address of the destination node.
   * \param next address of the next hop node.
   * \param interfaceAddress address of the local interface.
   * \param distance distance to the destination node.
   */
  void AddEntry (const Ipv4Address &dest,
                 const Ipv4Address &next,
                 const Ipv4Address &interfaceAddress,
                 uint32_t distance);

  /**
   * \brief Looks up an entry for the specified destination address.
   * \param [in] dest Destination address.
   * \param [out] outEntry Holds the routing entry result, if found.
   * \return true if found, false if not found.
   */
  bool Lookup (const Ipv4Address &dest,
               RoutingTableEntry &outEntry) const;

  /**
   * \brief Finds the appropriate entry which must be used in order to forward
   * a data packet to a next hop (given a destination).
   *
   * Imagine a routing table like this: [A,B] [B,C] [C,C]; being each pair of the
   * form [dest addr, next-hop addr]. In this case, if this function is invoked
   * with [A,B] then pair [C,C] is returned because C is the next hop that must be used
   * to forward a data packet destined to A. That is, C is a neighbor of this node,
   * but B isn't. This function finds the appropriate neighbor for forwarding a packet.
   *
   * \param[in] entry The routing table entry which indicates the destination node
   * we are interested in.
   *
   * \param[out] outEntry The appropriate routing table entry which indicates the next
   * hop which must be used for forwarding a data packet, or NULL if there is no such entry.
   *
   * \return True if an entry was found, false otherwise.
   */
  bool FindSendEntry (const RoutingTableEntry &entry,
                      RoutingTableEntry &outEntry) const;



  void DoDispose ();

  /**
   * Send an OLSR message.
   * \param packet The packet to be sent.
   * \param containedMessages The messages contained in the packet.
   */
  void SendPacket (Ptr<Packet> packet, const MessageList &containedMessages);

  /**
   * Increments packet sequence number and returns the new value.
   * \return The packet sequence number.
   */
  inline uint16_t GetPacketSequenceNumber ();

  /**
   * Increments message sequence number and returns the new value.
   * \return The message sequence number.
   */
  inline uint16_t GetMessageSequenceNumber ();

  /**
   * Receive an OLSR message.
   * \param socket The receiving socket.
   */
  void RecvOlsr (Ptr<Socket> socket);

  /**
   * \brief Computates MPR set of a node following \RFC{3626} hints.
   */
  void MprComputation ();

  /**
   * \brief Creates the routing table of the node following \RFC{3626} hints.
   */
  void RoutingTableComputation ();

  /**
   * \brief Gets the main address associated with a given interface address.
   * \param iface_addr the interface address.
   * \return the corresponding main address.
   */
  Ipv4Address GetMainAddress (Ipv4Address iface_addr) const;

  /**
   *  \brief Tests whether or not the specified route uses a non-OLSR outgoing interface.
   *  \param route The route to be tested.
   *  \returns True if the outgoing interface of the specified route is a non-OLSR interface, false otherwise.
   */
  bool UsesNonOlsrOutgoingInterface (const Ipv4RoutingTableEntry &route);

  // Timer handlers
  Timer m_helloTimer; //!< Timer for the HELLO message.
  /**
   * \brief Sends a HELLO message and reschedules the HELLO timer.
   */
  void HelloTimerExpire ();

  Timer m_tcTimer; //!< Timer for the TC message.
  /**
   * \brief Sends a TC message (if there exists any MPR selector) and reschedules the TC timer.
   */
  void TcTimerExpire ();

  Timer m_midTimer; //!< Timer for the MID message.
  /**
   * \brief \brief Sends a MID message (if the node has more than one interface) and resets the MID timer.
   */
  void MidTimerExpire ();

  Timer m_hnaTimer; //!< Timer for the HNA message.
  /**
   * \brief Sends an HNA message (if the node has associated hosts/networks) and reschedules the HNA timer.
   */
  void HnaTimerExpire ();

  /**
   * \brief Removes tuple if expired. Else timer is rescheduled to expire at tuple.expirationTime.
   *
   * The task of actually removing the tuple is left to the OLSR agent.
   *
   * \param address The address of the tuple.
   * \param sequenceNumber The sequence number of the tuple.
   */
  void DupTupleTimerExpire (Ipv4Address address, uint16_t sequenceNumber);

  bool m_linkTupleTimerFirstTime; //!< Flag to indicate if it is the first time the LinkTupleTimer fires.
  /**
   * \brief Removes tuple_ if expired. Else if symmetric time
   * has expired then it is assumed a neighbor loss and agent_->nb_loss()
   * is called. In this case the timer is rescheduled to expire at
   * tuple_->time(). Otherwise the timer is rescheduled to expire at
   * the minimum between tuple_->time() and tuple_->sym_time().
   *
   * The task of actually removing the tuple is left to the OLSR agent.
   *
   * \param neighborIfaceAddr The tuple neighbor interface address.
   */
  void LinkTupleTimerExpire (Ipv4Address neighborIfaceAddr);

  /**
   * \brief Removes 2_hop neighbor tuple_ if expired. Else the timer is rescheduled to expire at tuple_->time().
   *
   * The task of actually removing the tuple is left to the OLSR agent.
   *
   * \param neighborMainAddr The neighbor main address.
   * \param twoHopNeighborAddr The 2-hop neighbor address.
   */
  void Nb2hopTupleTimerExpire (Ipv4Address neighborMainAddr, Ipv4Address twoHopNeighborAddr);

  /**
   * \brief Removes MPR selector tuple_ if expired. Else the timer is rescheduled to expire at tuple_->time().
   *
   * The task of actually removing the tuple is left to the OLSR agent.
   *
   * \param mainAddr The tuple IPv4 address.
   */
  void MprSelTupleTimerExpire (Ipv4Address mainAddr);

  /**
   * \brief Removes topology tuple_ if expired. Else the timer is rescheduled to expire at tuple_->time().
   *
   * The task of actually removing the tuple is left to the OLSR agent.
   *
   * \param destAddr The destination address.
   * \param lastAddr The last address.
   */
  void TopologyTupleTimerExpire (Ipv4Address destAddr, Ipv4Address lastAddr);

  /**
   * \brief Removes interface association tuple_ if expired. Else the timer is rescheduled to expire at tuple_->time().
   *
   * \param ifaceAddr The interface address.
   */
  void IfaceAssocTupleTimerExpire (Ipv4Address ifaceAddr);

  /**
   * \brief Removes association tuple_ if expired. Else timer is rescheduled to expire at tuple_->time().
   *
   * \param gatewayAddr The gateway address.
   * \param networkAddr The network address.
   * \param netmask  The network mask.
   */
  void AssociationTupleTimerExpire (Ipv4Address gatewayAddr, Ipv4Address networkAddr, Ipv4Mask netmask);

  /**
   * Increments the ANSN counter.
   */
  void IncrementAnsn ();

  /// A list of pending messages which are buffered awaiting for being sent.
  olsr::MessageList m_queuedMessages;
  Timer m_queuedMessagesTimer; //!< timer for throttling outgoing messages

  /**
   * \brief OLSR's default forwarding algorithm.
   *
   * See \RFC{3626} for details.
   *
   * \param olsrMessage The %OLSR message which must be forwarded.
   * \param duplicated NULL if the message has never been considered for forwarding, or a duplicate tuple in other case.
   * \param localIface The address of the interface where the message was received from.
   * \param senderAddress The sender IPv4 address.
   */
  void ForwardDefault (olsr::MessageHeader olsrMessage,
                       DuplicateTuple *duplicated,
                       const Ipv4Address &localIface,
                       const Ipv4Address &senderAddress);

  /**
   * \brief Enques an %OLSR message which will be sent with a delay of (0, delay].
   *
   * This buffering system is used in order to piggyback several %OLSR messages in
   * a same %OLSR packet.
   *
   * \param message the %OLSR message which must be sent.
   * \param delay maximum delay the %OLSR message is going to be buffered.
   */
  void QueueMessage (const olsr::MessageHeader &message, Time delay);

  /**
   * \brief Creates as many %OLSR packets as needed in order to send all buffered
   * %OLSR messages.
   *
   * Maximum number of messages which can be contained in an %OLSR packet is
   * dictated by OLSR_MAX_MSGS constant.
   */
  void SendQueuedMessages ();

  /**
   * \brief Creates a new %OLSR HELLO message which is buffered for being sent later on.
   */
 void SendHello ();

  /**
   * \brief Creates a new %OLSR TC message which is buffered for being sent later on.
   */
  void SendTc ();

  /**
   * \brief Creates a new %OLSR MID message which is buffered for being sent later on.
   */
  void SendMid ();

  /**
   * \brief Creates a new %OLSR HNA message which is buffered for being sent later on.
   */
  void SendHna ();

  /**
   * \brief Performs all actions needed when a neighbor loss occurs.
   *
   * Neighbor Set, 2-hop Neighbor Set, MPR Set and MPR Selector Set are updated.
   *
   * \param tuple link tuple with the information of the link to the neighbor which has been lost.
   */
  void NeighborLoss (const LinkTuple &tuple);

  /**
   * \brief Adds a duplicate tuple to the Duplicate Set.
   *
   * \param tuple The duplicate tuple to be added.
   */
  void AddDuplicateTuple (const DuplicateTuple &tuple);

  /**
   * \brief Removes a duplicate tuple from the Duplicate Set.
   *
   * \param tuple The duplicate tuple to be removed.
   */
  void RemoveDuplicateTuple (const DuplicateTuple &tuple);

  /**
   * Adds a link tuple.
   * \param tuple Thetuple to be added.
   * \param willingness The tuple willingness.
   */
  void LinkTupleAdded (const LinkTuple &tuple, uint8_t willingness);

  /**
   * \brief Removes a link tuple from the Link Set.
   *
   * \param tuple The link tuple to be removed.
   */
  void RemoveLinkTuple (const LinkTuple &tuple);

  /**
   * \brief This function is invoked when a link tuple is updated. Its aim is to
   * also update the corresponding neighbor tuple if it is needed.
   *
   * \param tuple The link tuple which has been updated.
   * \param willingness The tuple willingness.
   */
  void LinkTupleUpdated (const LinkTuple &tuple, uint8_t willingness);

  /**
   * \brief Adds a neighbor tuple to the Neighbor Set.
   *
   * \param tuple The neighbor tuple to be added.
   */
  void AddNeighborTuple (const NeighborTuple &tuple);

  /**
   * \brief Removes a neighbor tuple from the Neighbor Set.
   *
   * \param tuple The neighbor tuple to be removed.
   */
  void RemoveNeighborTuple (const NeighborTuple &tuple);

  /**
   * \brief Adds a 2-hop neighbor tuple to the 2-hop Neighbor Set.
   *
   * \param tuple The 2-hop neighbor tuple to be added.
   */
  void AddTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple);

  /**
   * \brief Removes a 2-hop neighbor tuple from the 2-hop Neighbor Set.
   *
   * \param tuple The 2-hop neighbor tuple to be removed.
   */
  void RemoveTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple);

  /**
   * \brief Adds an MPR selector tuple to the MPR Selector Set.
   * Advertised Neighbor Sequence Number (ANSN) is also updated.
   *
   * \param tuple The MPR selector tuple to be added.
   */
  void AddMprSelectorTuple (const MprSelectorTuple  &tuple);

  /**
   * \brief Removes an MPR selector tuple from the MPR Selector Set.
   * Advertised Neighbor Sequence Number (ANSN) is also updated.
   *
   * \param tuple The MPR selector tuple to be removed.
   */
  void RemoveMprSelectorTuple (const MprSelectorTuple &tuple);

  /**
   * \brief Adds a topology tuple to the Topology Set.
   *
   * \param tuple The topology tuple to be added.
   */
  void AddTopologyTuple (const TopologyTuple &tuple);

  /**
   * \brief Removes a topology tuple to the Topology Set.
   *
   * \param tuple The topology tuple to be removed.
   */
  void RemoveTopologyTuple (const TopologyTuple &tuple);

  /**
   * \brief Adds an interface association tuple to the Interface Association Set.
   *
   * \param tuple The interface association tuple to be added.
   */
  void AddIfaceAssocTuple (const IfaceAssocTuple &tuple);

  /**
   * \brief Removed an interface association tuple to the Interface Association Set.
   *
   * \param tuple The interface association tuple to be removed.
   */
  void RemoveIfaceAssocTuple (const IfaceAssocTuple &tuple);

  /**
   * \brief Adds a host network association tuple to the Association Set.
   *
   * \param tuple The host network association tuple to be added.
   */
  void AddAssociationTuple (const AssociationTuple &tuple);

  /**
   * \brief Removes a host network association tuple to the Association Set.
   *
   * \param tuple The host network association tuple to be removed.
   */
  void RemoveAssociationTuple (const AssociationTuple &tuple);

  /**
   * \brief Processes a HELLO message following \RFC{3626} specification.
   *
   * Link sensing and population of the Neighbor Set, 2-hop Neighbor Set and MPR
   * Selector Set are performed.
   *
   * \param msg the %OLSR message which contains the HELLO message.
   * \param receiverIface the address of the interface where the message was received from.
   * \param senderIface the address of the interface where the message was sent from.
   */
  void ProcessHello (const olsr::MessageHeader &msg,
                     const Ipv4Address &receiverIface,
                     const Ipv4Address &senderIface);

  /**
   * \brief Processes a TC message following \RFC{3626} specification.
   *
   * The Topology Set is updated (if needed) with the information of
   * the received TC message.
   *
   * \param msg The %OLSR message which contains the TC message.
   * \param senderIface The address of the interface where the message was sent from.
   *
   */
  void ProcessTc (const olsr::MessageHeader &msg,
                  const Ipv4Address &senderIface);

  /**
   * \brief Processes a MID message following \RFC{3626} specification.
   *
   * The Interface Association Set is updated (if needed) with the information
   * of the received MID message.
   *
   * \param msg the %OLSR message which contains the MID message.
   * \param senderIface the address of the interface where the message was sent from.
   */
  void ProcessMid (const olsr::MessageHeader &msg,
                   const Ipv4Address &senderIface);

  /**
   *
   * \brief Processes a HNA message following \RFC{3626} specification.
   *
   * The Host Network Association Set is updated (if needed) with the information
   * of the received HNA message.
   *
   * \param msg the %OLSR message which contains the HNA message.
   * \param senderIface the address of the interface where the message was sent from.
   *
   */
  void ProcessHna (const olsr::MessageHeader &msg,
                   const Ipv4Address &senderIface);

  /**
   * \brief Updates Link Set according to a new received HELLO message
   * (following \RFC{3626} specification). Neighbor Set is also updated if needed.
   * \param msg The received message.
   * \param hello The received HELLO sub-message.
   * \param receiverIface The interface that received the message.
   * \param senderIface The sender interface.
   */
  void LinkSensing (const olsr::MessageHeader &msg,
                    const olsr::MessageHeader::Hello &hello,
                    const Ipv4Address &receiverIface,
                    const Ipv4Address &senderIface);

  /**
   * \brief Updates the Neighbor Set according to the information contained in
   * a new received HELLO message (following \RFC{3626}).
   * \param msg The received message.
   * \param hello The received HELLO sub-message.
   */
  void PopulateNeighborSet (const olsr::MessageHeader &msg,
                            const olsr::MessageHeader::Hello &hello);

  /**
   * \brief Updates the 2-hop Neighbor Set according to the information contained
   * in a new received HELLO message (following \RFC{3626}).
   * \param msg The received message.
   * \param hello The received HELLO sub-message.
   */
  void PopulateTwoHopNeighborSet (const olsr::MessageHeader &msg,
                                  const olsr::MessageHeader::Hello &hello);

  /**
   * \brief Updates the MPR Selector Set according to the information contained in
   * a new received HELLO message (following \RFC{3626}).
   * \param msg The received message.
   * \param hello The received HELLO sub-message.
   */
  void PopulateMprSelectorSet (const olsr::MessageHeader &msg,
                               const olsr::MessageHeader::Hello &hello);


  /// Check that address is one of my interfaces
  bool IsMyOwnAddress (const Ipv4Address & a) const;

  Ipv4Address m_mainAddress; //!< the node main address.

  // One socket per interface, each bound to that interface's address
  // (reason: for OLSR Link Sensing we need to know on which interface
  // HELLO messages arrive)
  std::map< Ptr<Socket>, Ipv4InterfaceAddress > m_socketAddresses; //!< Container of sockets and the interfaces they are opened onto.

  /// Rx packet trace.
  TracedCallback <const PacketHeader &, const MessageList &> m_rxPacketTrace;

  /// Tx packet trace.
  TracedCallback <const PacketHeader &, const MessageList &> m_txPacketTrace;

  /// Routing table chanes challback
  TracedCallback <uint32_t> m_routingTableChanged;

  /// Provides uniform random variables.




namespace ns3 {
namespace olsr {

/// \ingroup olsr
/// This class encapsulates all data structures needed for maintaining internal state of an OLSR node.
class OlsrState
{
  //  friend class Olsr;

protected:
  LinkSet m_linkSet;    //!< Link Set (\RFC{3626}, section 4.2.1).
  NeighborSet m_neighborSet;            //!< Neighbor Set (\RFC{3626}, section 4.3.1).
  TwoHopNeighborSet m_twoHopNeighborSet;        //!< 2-hop Neighbor Set (\RFC{3626}, section 4.3.2).
  TopologySet m_topologySet;    //!< Topology Set (\RFC{3626}, section 4.4).
  MprSet m_mprSet;      //!< MPR Set (\RFC{3626}, section 4.3.3).
  MprSelectorSet m_mprSelectorSet;      //!< MPR Selector Set (\RFC{3626}, section 4.3.4).
  DuplicateSet m_duplicateSet;  //!< Duplicate Set (\RFC{3626}, section 3.4).
  IfaceAssocSet m_ifaceAssocSet;        //!< Interface Association Set (\RFC{3626}, section 4.1).
  AssociationSet m_associationSet; //!<	Association Set (\RFC{3626}, section12.2). Associations obtained from HNA messages generated by other nodes.
  Associations m_associations;  //!< The node's local Host Network Associations that will be advertised using HNA messages.

public:


  {}

  // MPR selector

  /**
   * Gets the MPR selectors.
   * \returns The MPR selectors.
   */
  const MprSelectorSet & GetMprSelectors () const
  {
    return m_mprSelectorSet;
  }

  /**
   * Finds a MPR selector tuple.
   * \param mainAddr The MPR selector main address.
   * \returns The MPR selector, if found. Else it returns a null pointer.
   */
  MprSelectorTuple* FindMprSelectorTuple (const Ipv4Address &mainAddr);

  /**
   * Erases a MPR selector tuple.
   * \param tuple The MPR selector tuple.
   */
  void EraseMprSelectorTuple (const MprSelectorTuple &tuple);

  /**
   * Erases all MPR selector tuples belonging to the same address.
   * \param mainAddr The MPR selector main address.
   */
  void EraseMprSelectorTuples (const Ipv4Address &mainAddr);

  /**
   * Inserts a MPR selector tuple
   * \param tuple The MPR selector tuple.
   */
  void InsertMprSelectorTuple (const MprSelectorTuple &tuple);

  /**
   * Prints the MPR selector sets.
   * \return a string with the output data.
   */
  std::string PrintMprSelectorSet () const;

  // Neighbor

  /**
   * Gets the neighbor set.
   * \returns The neighbor set.
   */
  const NeighborSet & GetNeighbors () const
  {
    return m_neighborSet;
  }
  /**
   * Gets the neighbor set.
   * \returns The neighbor set.
   */
  NeighborSet & GetNeighbors ()
  {
    return m_neighborSet;
  }

  /**
   * Finds a neighbor tuple.
   * \param mainAddr The neighbor tuple main address.
   * \returns The neighbor tuple, if found. Else it returns a null pointer.
   */
  NeighborTuple* FindNeighborTuple (const Ipv4Address &mainAddr);

  /**
   * Finds a symmetrical neighbor tuple.
   * \param mainAddr The neighbor tuple main address.
   * \returns The neighbor tuple, if found. Else it returns a null pointer.
   */
  const NeighborTuple* FindSymNeighborTuple (const Ipv4Address &mainAddr) const;

  /**
   * Finds a neighbor tuple.
   * \param mainAddr The neighbor tuple main address.
   * \param willingness The neighbor willingness.
   * \returns The neighbor tuple, if found. Else it returns a null pointer.
   */
  NeighborTuple* FindNeighborTuple (const Ipv4Address &mainAddr,
                                    uint8_t willingness);

  /**
   * Erases a neighbor tuple.
   * \param neighborTuple The neighbor tuple.
   */
  void EraseNeighborTuple (const NeighborTuple &neighborTuple);
  /**
   * Erases a neighbor tuple.
   * \param mainAddr The neighbor tuple main address.
   */
  void EraseNeighborTuple (const Ipv4Address &mainAddr);

  /**
   * Inserts a neighbor tuple.
   * \param tuple The neighbor tuple.
   */
  void InsertNeighborTuple (const NeighborTuple &tuple);

  // Two-hop neighbor

  /**
   * Gets the 2-hop neighbor set.
   * \returns The 2-hop neighbor set.
   */
  const TwoHopNeighborSet & GetTwoHopNeighbors () const
  {
    return m_twoHopNeighborSet;
  }
  /**
   * Gets the 2-hop neighbor set.
   * \returns The 2-hop neighbor set.
   */
  TwoHopNeighborSet & GetTwoHopNeighbors ()
  {
    return m_twoHopNeighborSet;
  }

  /**
   * Finds a 2-hop neighbor tuple.
   * \param neighbor The neighbor main address.
   * \param twoHopNeighbor The 2-hop neighbor main address.
   * \returns The 2-hop neighbor tuple, if found. Else it returns a null pointer.
   */
  TwoHopNeighborTuple* FindTwoHopNeighborTuple (const Ipv4Address &neighbor,
                                                const Ipv4Address &twoHopNeighbor);

  /**
   * Erases a 2-hop neighbor tuple.
   * \param tuple The 2-hop neighbor tuple.
   */
  void EraseTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple);
  /**
   * Erases the 2-hop neighbor tuples with the same 1-hop neighbor.
   * \param neighbor The neighbor address.
   */
  void EraseTwoHopNeighborTuples (const Ipv4Address &neighbor);
  /**
   * Erases the 2-hop neighbor tuples with matching predicates.
   * \param neighbor The neighbor address.
   * \param twoHopNeighbor The 2-hop neighbor main address.
   */
  void EraseTwoHopNeighborTuples (const Ipv4Address &neighbor,
                                  const Ipv4Address &twoHopNeighbor);
  /**
   * Inserts a 2-hop neighbor tuple.
   * \param tuple The 2-hop neighbor tuple.
   */
  void InsertTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple);

  // MPR

  /**
   * Checks if there's an MPR with a specific address.
   * \param address The address to test.
   * \return True if a MPR with the specified address exists.
   */
  bool FindMprAddress (const Ipv4Address &address);

  /**
   * Sets the MPR set to the one specified.
   * \param mprSet The new MPR set.
   */
  void SetMprSet (MprSet mprSet);

  /**
   * Gets the MPR set.
   * \return The MPR set.
   */
  MprSet GetMprSet () const;

  // Duplicate

  /**
   * Finds a duplicate tuple.
   * \param address The duplicate tuple address.
   * \param sequenceNumber The duplicate tuple sequence number.
   * \returns The duplicate tuple, or a null pointer if no match.
   */
  DuplicateTuple* FindDuplicateTuple (const Ipv4Address &address,
                                      uint16_t sequenceNumber);

  /**
   * Erases a duplicate tuple.
   * \param tuple The tuple to erase.
   */
  void EraseDuplicateTuple (const DuplicateTuple &tuple);
  /**
   * Inserts a duplicate tuple.
   * \param tuple The tuple to insert.
   */
  void InsertDuplicateTuple (const DuplicateTuple &tuple);

  // Link

  /**
   * Gets the Link set.
   * \return The Link set.
   */
  const LinkSet & GetLinks () const
  {
    return m_linkSet;
  }
  /**
   * Finds a link tuple.
   * \param ifaceAddr The interface address of the link.
   * \returns The link tuple, or a null pointer if no match.
   */
  LinkTuple* FindLinkTuple (const Ipv4Address &ifaceAddr);
  /**
   * Finds a symmetrical link tuple.
   * \param ifaceAddr The interface address of the link.
   * \param time The time at which the link should be considered symmetrical.
   * \returns The link tuple, or a null pointer if no match.
   */
  LinkTuple* FindSymLinkTuple (const Ipv4Address &ifaceAddr, Time time);
  /**
   * Erases a link tuple.
   * \param tuple The tuple to erase.
   */
  void EraseLinkTuple (const LinkTuple &tuple);
  /**
   * Inserts a link tuple.
   * \param tuple The tuple to insert.
   * \returns A reference to the inserted tuple.
   */
  LinkTuple& InsertLinkTuple (const LinkTuple &tuple);

  // Topology

  /**
   * Gets the topology set.
   * \returns The topology set.
   */
  const TopologySet & GetTopologySet () const
  {
    return m_topologySet;
  }
  /**
   * Finds a topology tuple.
   * \param destAddr The destination address.
   * \param lastAddr The address of the node previous to the destination.
   * \returns The topology tuple, or a null pointer if no match.
   */
  TopologyTuple* FindTopologyTuple (const Ipv4Address &destAddr,
                                    const Ipv4Address &lastAddr);
  /**
   * Finds a topology tuple.
   * \param lastAddr The address of the node previous to the destination.
   * \param ansn The Advertised Neighbor Sequence Number.
   * \returns The topology tuple, or a null pointer if no match.
   */
  TopologyTuple* FindNewerTopologyTuple (const Ipv4Address &lastAddr,
                                         uint16_t ansn);
  /**
   * Erases a topology tuple.
   * \param tuple The tuple to erase.
   */
  void EraseTopologyTuple (const TopologyTuple &tuple);
  /**
   * Erases a topology tuple.
   * \param lastAddr The address of the node previous to the destination.
   * \param ansn The Advertised Neighbor Sequence Number.
   */
  void EraseOlderTopologyTuples (const Ipv4Address &lastAddr,
                                 uint16_t ansn);
  /**
   * Inserts a topology tuple.
   * \param tuple The tuple to insert.
   */
  void InsertTopologyTuple (const TopologyTuple &tuple);

  // Interface association

  /**
   * Gets the interface association set.
   * \returns The interface association set.
   */
  const IfaceAssocSet & GetIfaceAssocSet () const
  {
    return m_ifaceAssocSet;
  }
  /**
   * Gets a mutable reference to the interface association set.
   * \returns The interface association set.
   */
  IfaceAssocSet & GetIfaceAssocSetMutable ()
  {
    return m_ifaceAssocSet;
  }

  /**
   * Finds a interface association tuple.
   * \param ifaceAddr The interface address.
   * \returns The interface association  tuple, or a null pointer if no match.
   */
  IfaceAssocTuple* FindIfaceAssocTuple (const Ipv4Address &ifaceAddr);
  /**
   * Finds a interface association tuple.
   * \param ifaceAddr The interface address.
   * \returns The interface association  tuple, or a null pointer if no match.
   */
  const IfaceAssocTuple* FindIfaceAssocTuple (const Ipv4Address &ifaceAddr) const;
  /**
   * Erases a interface association tuple.
   * \param tuple The tuple to erase.
   */
  void EraseIfaceAssocTuple (const IfaceAssocTuple &tuple);
  /**
   * Inserts a interface association tuple.
   * \param tuple The tuple to insert.
   */
  void InsertIfaceAssocTuple (const IfaceAssocTuple &tuple);

  // Host-Network Association
  /**
   * Gets the association set known to the node.
   * \returns The association set known to the node.
   */
  const AssociationSet & GetAssociationSet () const  // Associations known to the node
  {
    return m_associationSet;
  }

  /**
   * Gets the association set the node has.
   * \returns The association set the node has.
   */
  const Associations & GetAssociations () const  // Set of associations that the node has
  {
    return m_associations;
  }

  /**
   * Finds an association tuple.
   * \param gatewayAddr The gateway address.
   * \param networkAddr The network address.
   * \param netmask The network mask.
   * \returns The association  tuple, or a null pointer if no match.
   */
  AssociationTuple* FindAssociationTuple (const Ipv4Address &gatewayAddr, \
                                          const Ipv4Address &networkAddr, \
                                          const Ipv4Mask &netmask);
  /**
   * Erases a known association tuple.
   * \param tuple The tuple to erase.
   */
  void EraseAssociationTuple (const AssociationTuple &tuple);
  /**
   * Inserts a known association tuple.
   * \param tuple The tuple to insert.
   */
  void InsertAssociationTuple (const AssociationTuple &tuple);
  /**
   * Erases an association.
   * \param tuple The tuple to erase.
   */
  void EraseAssociation (const Association &tuple);
  /**
   * Inserts an association tuple.
   * \param tuple The tuple to insert.
   */
  void InsertAssociation (const Association &tuple);

  /**
   * Returns a vector of all interfaces of a given neighbor, with the
   * exception of the "main" one.
   * \param neighborMainAddr The neighbor main address
   * \returns A container of the neighbor addresses (excluding the main one).
   */
  std::vector<Ipv4Address>
  FindNeighborInterfaces (const Ipv4Address &neighborMainAddr) const;


Return to bug 938