dsr-options.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Yufei Cheng
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Yufei Cheng   <yfcheng@ittc.ku.edu>
 *
 * James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
 * ResiliNets Research Group  https://resilinets.org/
 * Information and Telecommunication Technology Center (ITTC)
 * and Department of Electrical Engineering and Computer Science
 * The University of Kansas Lawrence, KS USA.
 *
 * Work supported in part by NSF FIND (Future Internet Design) Program
 * under grant CNS-0626918 (Postmodern Internet Architecture),
 * NSF grant CNS-1050226 (Multilayer Network Resilience Analysis and Experimentation on GENI),
 * US Department of Defense (DoD), and ITTC at The University of Kansas.
 */
 
#define NS_LOG_APPEND_CONTEXT                                                                      \
    if (GetObject<Node>())                                                                         \
    {                                                                                              \
        std::clog << "[node " << GetObject<Node>()->GetId() << "] ";                               \
    }
 
#include "dsr-options.h"
 
#include "dsr-option-header.h"
#include "dsr-rcache.h"
 
#include "ns3/assert.h"
#include "ns3/fatal-error.h"
#include "ns3/icmpv4-l4-protocol.h"
#include "ns3/ip-l4-protocol.h"
#include "ns3/ipv4-address.h"
#include "ns3/ipv4-header.h"
#include "ns3/ipv4-interface.h"
#include "ns3/ipv4-l3-protocol.h"
#include "ns3/ipv4-route.h"
#include "ns3/log.h"
#include "ns3/node-list.h"
#include "ns3/node.h"
#include "ns3/object-vector.h"
#include "ns3/pointer.h"
#include "ns3/ptr.h"
#include "ns3/trace-source-accessor.h"
#include "ns3/udp-header.h"
#include "ns3/uinteger.h"
 
#include <algorithm>
#include <ctime>
#include <list>
#include <map>
 
namespace ns3
{
 
NS_LOG_COMPONENT_DEFINE("DsrOptions");
 
namespace dsr
{
 
NS_OBJECT_ENSURE_REGISTERED(DsrOptions);
 
TypeId
DsrOptions::GetTypeId()
{
    static TypeId tid = TypeId("ns3::dsr::DsrOptions")
                            .SetParent<Object>()
                            .SetGroupName("Dsr")
                            .AddAttribute("OptionNumber",
                                          "The Dsr option number.",
                                          UintegerValue(0),
                                          MakeUintegerAccessor(&DsrOptions::GetOptionNumber),
                                          MakeUintegerChecker<uint8_t>())
                            .AddTraceSource("Drop",
                                            "Packet dropped.",
                                            MakeTraceSourceAccessor(&DsrOptions::m_dropTrace),
                                            "ns3::Packet::TracedCallback")
                            .AddTraceSource("Rx",
                                            "Receive DSR packet.",
                                            MakeTraceSourceAccessor(&DsrOptions::m_rxPacketTrace),
                                            "ns3::dsr::DsrOptionSRHeader::TracedCallback");
    return tid;
}
 
DsrOptions::DsrOptions()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
DsrOptions::~DsrOptions()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
void
DsrOptions::SetNode(Ptr<Node> node)
{
    NS_LOG_FUNCTION(this << node);
    m_node = node;
}
 
Ptr<Node>
DsrOptions::GetNode() const
{
    NS_LOG_FUNCTION_NOARGS();
    return m_node;
}
 
bool
DsrOptions::ContainAddressAfter(Ipv4Address ipv4Address,
                                Ipv4Address destAddress,
                                std::vector<Ipv4Address>& nodeList)
{
    NS_LOG_FUNCTION(this << ipv4Address << destAddress);
    auto it = find(nodeList.begin(), nodeList.end(), destAddress);
 
    for (auto i = it; i != nodeList.end(); ++i)
    {
        if ((ipv4Address == (*i)) && ((*i) != nodeList.back()))
        {
            return true;
        }
    }
    return false;
}
 
std::vector<Ipv4Address>
DsrOptions::CutRoute(Ipv4Address ipv4Address, std::vector<Ipv4Address>& nodeList)
{
    NS_LOG_FUNCTION(this << ipv4Address);
    auto it = find(nodeList.begin(), nodeList.end(), ipv4Address);
    std::vector<Ipv4Address> cutRoute;
    for (auto i = it; i != nodeList.end(); ++i)
    {
        cutRoute.push_back(*i);
    }
    return cutRoute;
}
 
Ptr<Ipv4Route>
DsrOptions::SetRoute(Ipv4Address nextHop, Ipv4Address srcAddress)
{
    NS_LOG_FUNCTION(this << nextHop << srcAddress);
    m_ipv4Route = Create<Ipv4Route>();
    m_ipv4Route->SetDestination(nextHop);
    m_ipv4Route->SetGateway(nextHop);
    m_ipv4Route->SetSource(srcAddress);
    return m_ipv4Route;
}
 
bool
DsrOptions::ReverseRoutes(std::vector<Ipv4Address>& vec)
{
    NS_LOG_FUNCTION(this);
 
    std::reverse(vec.begin(), vec.end());
 
    return true;
}
 
Ipv4Address
DsrOptions::SearchNextHop(Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec)
{
    NS_LOG_FUNCTION(this << ipv4Address);
    Ipv4Address nextHop;
    NS_LOG_DEBUG("the vector size " << vec.size());
    if (vec.size() == 2)
    {
        NS_LOG_DEBUG("The two nodes are neighbors");
        nextHop = vec[1];
        return nextHop;
    }
 
    if (ipv4Address == vec.back())
    {
        NS_LOG_DEBUG("We have reached to the final destination " << ipv4Address << " "
                                                                 << vec.back());
        return ipv4Address;
    }
    for (auto i = vec.begin(); i != vec.end(); ++i)
    {
        if (ipv4Address == (*i))
        {
            nextHop = *(++i);
            return nextHop;
        }
    }
 
    NS_LOG_DEBUG("next hop address not found, route corrupted");
    Ipv4Address none = "0.0.0.0";
    return none;
}
 
Ipv4Address
DsrOptions::ReverseSearchNextHop(Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec)
{
    NS_LOG_FUNCTION(this << ipv4Address);
    Ipv4Address nextHop;
    if (vec.size() == 2)
    {
        NS_LOG_DEBUG("The two nodes are neighbors");
        nextHop = vec[0];
        return nextHop;
    }
 
    for (auto ri = vec.rbegin(); ri != vec.rend(); ++ri)
    {
        if (ipv4Address == (*ri))
        {
            nextHop = *(++ri);
            return nextHop;
        }
    }
 
    NS_LOG_DEBUG("next hop address not found, route corrupted");
    Ipv4Address none = "0.0.0.0";
    return none;
}
 
Ipv4Address
DsrOptions::ReverseSearchNextTwoHop(Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec)
{
    NS_LOG_FUNCTION(this << ipv4Address);
    Ipv4Address nextTwoHop;
    NS_LOG_DEBUG("The vector size " << vec.size());
    NS_ASSERT(vec.size() > 2);
    for (auto ri = vec.rbegin(); ri != vec.rend(); ++ri)
    {
        if (ipv4Address == (*ri))
        {
            nextTwoHop = *(ri + 2);
            return nextTwoHop;
        }
    }
    NS_FATAL_ERROR("next hop address not found, route corrupted");
    Ipv4Address none = "0.0.0.0";
    return none;
}
 
void
DsrOptions::PrintVector(std::vector<Ipv4Address>& vec)
{
    NS_LOG_FUNCTION(this);
    /*
     * Check elements in a route vector
     */
    if (vec.empty())
    {
        NS_LOG_DEBUG("The vector is empty");
    }
    else
    {
        NS_LOG_DEBUG("Print all the elements in a vector");
        for (auto i = vec.begin(); i != vec.end(); ++i)
        {
            NS_LOG_DEBUG("The ip address " << *i);
        }
    }
}
 
bool
DsrOptions::IfDuplicates(std::vector<Ipv4Address>& vec, std::vector<Ipv4Address>& vec2)
{
    NS_LOG_FUNCTION(this);
    for (auto i = vec.begin(); i != vec.end(); ++i)
    {
        for (auto j = vec2.begin(); j != vec2.end(); ++j)
        {
            if ((*i) == (*j))
            {
                return true;
            }
        }
    }
    return false;
}
 
bool
DsrOptions::CheckDuplicates(Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec)
{
    NS_LOG_FUNCTION(this << ipv4Address);
    for (auto i = vec.begin(); i != vec.end(); ++i)
    {
        if ((*i) == ipv4Address)
        {
            return true;
        }
    }
    return false;
}
 
void
DsrOptions::RemoveDuplicates(std::vector<Ipv4Address>& vec)
{
    NS_LOG_FUNCTION(this);
    // Remove duplicate ip address from the route if any, should not happen with normal behavior
    // nodes
    std::vector<Ipv4Address> vec2(vec); // declare vec2 as a copy of the vec
    PrintVector(vec2);                  // Print all the ip address in the route
    vec.clear();                        // clear vec
    for (auto i = vec2.begin(); i != vec2.end(); ++i)
    {
        if (vec.empty())
        {
            vec.push_back(*i);
            continue;
        }
 
        for (auto j = vec.begin(); j != vec.end(); ++j)
        {
            if ((*i) == (*j))
            {
                if ((j + 1) != vec.end())
                {
                    vec.erase(j + 1, vec.end()); // Automatic shorten the route
                }
 
                break;
            }
            else if (j == (vec.end() - 1))
            {
                vec.push_back(*i);
                break;
            }
        }
    }
}
 
uint32_t
DsrOptions::GetIDfromIP(Ipv4Address address)
{
    NS_LOG_FUNCTION(this << address);
    int32_t nNodes = NodeList::GetNNodes();
    for (int32_t i = 0; i < nNodes; ++i)
    {
        Ptr<Node> node = NodeList::GetNode(i);
        Ptr<Ipv4> ipv4 = node->GetObject<Ipv4>();
        if (ipv4->GetAddress(1, 0).GetLocal() == address)
        {
            return i;
        }
    }
    return 255;
}
 
Ptr<Node>
DsrOptions::GetNodeWithAddress(Ipv4Address ipv4Address)
{
    NS_LOG_FUNCTION(this << ipv4Address);
    int32_t nNodes = NodeList::GetNNodes();
    for (int32_t i = 0; i < nNodes; ++i)
    {
        Ptr<Node> node = NodeList::GetNode(i);
        Ptr<Ipv4> ipv4 = node->GetObject<Ipv4>();
        int32_t ifIndex = ipv4->GetInterfaceForAddress(ipv4Address);
        if (ifIndex != -1)
        {
            return node;
        }
    }
    return nullptr;
}
 
NS_OBJECT_ENSURE_REGISTERED(DsrOptionPad1);
 
TypeId
DsrOptionPad1::GetTypeId()
{
    static TypeId tid = TypeId("ns3::dsr::DsrOptionPad1")
                            .SetParent<DsrOptions>()
                            .SetGroupName("Dsr")
                            .AddConstructor<DsrOptionPad1>();
    return tid;
}
 
DsrOptionPad1::DsrOptionPad1()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
DsrOptionPad1::~DsrOptionPad1()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
uint8_t
DsrOptionPad1::GetOptionNumber() const
{
    NS_LOG_FUNCTION_NOARGS();
 
    return OPT_NUMBER;
}
 
uint8_t
DsrOptionPad1::Process(Ptr<Packet> packet,
                       Ptr<Packet> dsrP,
                       Ipv4Address ipv4Address,
                       Ipv4Address source,
                       const Ipv4Header& ipv4Header,
                       uint8_t protocol,
                       bool& isPromisc,
                       Ipv4Address promiscSource)
{
    NS_LOG_FUNCTION(this << packet << dsrP << ipv4Address << source << ipv4Header
                         << (uint32_t)protocol << isPromisc);
    Ptr<Packet> p = packet->Copy();
    DsrOptionPad1Header pad1Header;
    p->RemoveHeader(pad1Header);
 
    isPromisc = false;
 
    return pad1Header.GetSerializedSize();
}
 
NS_OBJECT_ENSURE_REGISTERED(DsrOptionPadn);
 
TypeId
DsrOptionPadn::GetTypeId()
{
    static TypeId tid = TypeId("ns3::dsr::DsrOptionPadn")
                            .SetParent<DsrOptions>()
                            .SetGroupName("Dsr")
                            .AddConstructor<DsrOptionPadn>();
    return tid;
}
 
DsrOptionPadn::DsrOptionPadn()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
DsrOptionPadn::~DsrOptionPadn()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
uint8_t
DsrOptionPadn::GetOptionNumber() const
{
    NS_LOG_FUNCTION_NOARGS();
    return OPT_NUMBER;
}
 
uint8_t
DsrOptionPadn::Process(Ptr<Packet> packet,
                       Ptr<Packet> dsrP,
                       Ipv4Address ipv4Address,
                       Ipv4Address source,
                       const Ipv4Header& ipv4Header,
                       uint8_t protocol,
                       bool& isPromisc,
                       Ipv4Address promiscSource)
{
    NS_LOG_FUNCTION(this << packet << dsrP << ipv4Address << source << ipv4Header
                         << (uint32_t)protocol << isPromisc);
 
    Ptr<Packet> p = packet->Copy();
    DsrOptionPadnHeader padnHeader;
    p->RemoveHeader(padnHeader);
 
    isPromisc = false;
 
    return padnHeader.GetSerializedSize();
}
 
NS_OBJECT_ENSURE_REGISTERED(DsrOptionRreq);
 
TypeId
DsrOptionRreq::GetTypeId()
{
    static TypeId tid = TypeId("ns3::dsr::DsrOptionRreq")
                            .SetParent<DsrOptions>()
                            .SetGroupName("Dsr")
                            .AddConstructor<DsrOptionRreq>();
    return tid;
}
 
DsrOptionRreq::DsrOptionRreq()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
DsrOptionRreq::~DsrOptionRreq()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
uint8_t
DsrOptionRreq::GetOptionNumber() const
{
    NS_LOG_FUNCTION_NOARGS();
 
    return OPT_NUMBER;
}
 
uint8_t
DsrOptionRreq::Process(Ptr<Packet> packet,
                       Ptr<Packet> dsrP,
                       Ipv4Address ipv4Address,
                       Ipv4Address source,
                       const Ipv4Header& ipv4Header,
                       uint8_t protocol,
                       bool& isPromisc,
                       Ipv4Address promiscSource)
{
    NS_LOG_FUNCTION(this << packet << dsrP << ipv4Address << source << ipv4Header
                         << (uint32_t)protocol << isPromisc);
    // Fields from IP header
    Ipv4Address srcAddress = ipv4Header.GetSource();
    /*
     * \ when the ip source address is equal to the address of our own, this is request packet
     * originated \ by the node itself, discard it
     */
    if (source == ipv4Address)
    {
        NS_LOG_DEBUG("Discard the packet since it was originated from same source address");
        m_dropTrace(packet); // call the drop trace to show in the tracing
        return 0;
    }
    /*
     * Get the node associated with the ipv4 address and get several objects from the node and leave
     * for further use
     */
    Ptr<Node> node = GetNodeWithAddress(ipv4Address);
    Ptr<dsr::DsrRouting> dsr = node->GetObject<dsr::DsrRouting>();
 
    Ptr<Packet> p =
        packet->Copy(); // Note: The packet here doesn't contain the fixed size dsr header
    /*
     * @brief Get the number of routers' address field before removing the header
     * @peek the packet and get the value
     */
    uint8_t buf[2];
    p->CopyData(buf, sizeof(buf));
    uint8_t numberAddress = (buf[1] - 6) / 4;
    NS_LOG_DEBUG("The number of Ip addresses " << (uint32_t)numberAddress);
    if (numberAddress >= 255)
    {
        NS_LOG_DEBUG("Discard the packet, malformed header since two many ip addresses in route");
        m_dropTrace(packet); // call the drop trace to show in the tracing
        return 0;
    }
 
    /*
     * Create the dsr rreq header
     */
    DsrOptionRreqHeader rreq;
    /*
     * Set the number of addresses with the value from peek data and remove the rreq header
     */
    rreq.SetNumberAddress(numberAddress);
    // Remove the route request header
    p->RemoveHeader(rreq);
    // Verify the option length
    uint8_t length = rreq.GetLength();
    if (length % 2 != 0)
    {
        NS_LOG_LOGIC("Malformed header. Drop!");
        m_dropTrace(packet); // call drop trace
        return 0;
    }
    // Check the rreq id for verifying the request id
    uint16_t requestId = rreq.GetId();
    // The target address is where we want to send the data packets
    Ipv4Address targetAddress = rreq.GetTarget();
    // Get the node list and source address from the route request header
    std::vector<Ipv4Address> mainVector = rreq.GetNodesAddresses();
    std::vector<Ipv4Address> nodeList(mainVector);
    // Get the real source address of this request, it will be used when checking if we have
    // received the save route request before or not
    Ipv4Address sourceAddress = nodeList.front();
    PrintVector(nodeList);
    /*
     * Construct the dsr routing header for later use
     */
    DsrRoutingHeader dsrRoutingHeader;
    dsrRoutingHeader.SetNextHeader(protocol);
    dsrRoutingHeader.SetMessageType(1);
    dsrRoutingHeader.SetSourceId(GetIDfromIP(source));
    dsrRoutingHeader.SetDestId(255);
 
    // check whether we have received this request or not, if not, it will save the request in the
    // table for later use, if not found, return false, and push the newly received source request
    // entry in the cache
 
    // Get the TTL value, this is used to test if the packet will be forwarded or not
    uint8_t ttl = ipv4Header.GetTtl();
    bool dupRequest = false; // initialize the duplicate request check value
    if (ttl)
    {
        // if the ttl value is not 0, then this request will be forwarded, then we need to
        // save it in the source entry
        dupRequest = dsr->FindSourceEntry(sourceAddress, targetAddress, requestId);
    }
    /*
     * Before processing the route request, we need to check two things
     * 1. if this is the exact same request we have just received, ignore it
     * 2. if our address is already in the path list, ignore it
     * 3. otherwise process further
     */
 
    if (dupRequest)
    {
        // We have received this same route request before, not forwarding it now
        NS_LOG_LOGIC("Duplicate request. Drop!");
        m_dropTrace(packet); // call drop trace
        return 0;
    }
 
    else if (CheckDuplicates(ipv4Address, nodeList))
    {
        /*
         * if the route contains the node address already, drop the request packet
         */
        m_dropTrace(packet); // call drop trace
        NS_LOG_DEBUG("Our node address is already seen in the route, drop the request");
        return 0;
    }
    else
    {
        // A node ignores all RREQs received from any node in its blacklist
        DsrRouteCacheEntry toPrev;
        bool isRouteInCache = dsr->LookupRoute(targetAddress, toPrev);
        DsrRouteCacheEntry::IP_VECTOR ip =
            toPrev.GetVector(); // The route from our own route cache to dst
        PrintVector(ip);
        std::vector<Ipv4Address> saveRoute(nodeList);
        PrintVector(saveRoute);
        bool areThereDuplicates = IfDuplicates(ip, saveRoute);
        /*
         *  When the reverse route is created or updated, the following actions on the route are
         * also carried out:
         *  3. the next hop in the routing table becomes the node from which the  RREQ was received
         *  4. the hop count is copied from the Hop Count in the RREQ message;
         */
 
        //  A node generates a RREP if either:
        //  (i)  it is itself the destination,
        /*
         * The target address equal to our own ip address
         */
        NS_LOG_DEBUG("The target address over here " << targetAddress << " and the ip address "
                                                     << ipv4Address << " and the source address "
                                                     << mainVector[0]);
        if (targetAddress == ipv4Address)
        {
            Ipv4Address nextHop; // Declare the next hop address to use
            if (nodeList.size() == 1)
            {
                NS_LOG_DEBUG("These two nodes are neighbors");
                m_finalRoute.clear();
                /// TODO has changed the srcAddress to source, should not matter either way, check
                /// later
                m_finalRoute.push_back(source);      // push back the request originator's address
                m_finalRoute.push_back(ipv4Address); // push back our own address
                nextHop = srcAddress;
            }
            else
            {
                std::vector<Ipv4Address> changeRoute(nodeList);
                changeRoute.push_back(ipv4Address); // push back our own address
                m_finalRoute.clear();               // get a clear route vector
                for (auto i = changeRoute.begin(); i != changeRoute.end(); ++i)
                {
                    m_finalRoute.push_back(*i); // Get the full route from source to destination
                }
                PrintVector(m_finalRoute);
                nextHop = ReverseSearchNextHop(ipv4Address, m_finalRoute); // get the next hop
            }
 
            DsrOptionRrepHeader rrep;
            rrep.SetNodesAddress(m_finalRoute); // Set the node addresses in the route reply header
            NS_LOG_DEBUG("The nextHop address " << nextHop);
            Ipv4Address replyDst = m_finalRoute.front();
            /*
             * This part add dsr header to the packet and send route reply packet
             */
            DsrRoutingHeader dsrRoutingHeader;
            dsrRoutingHeader.SetNextHeader(protocol);
            dsrRoutingHeader.SetMessageType(1);
            dsrRoutingHeader.SetSourceId(GetIDfromIP(ipv4Address));
            dsrRoutingHeader.SetDestId(GetIDfromIP(replyDst));
            // Set the route for route reply
            SetRoute(nextHop, ipv4Address);
 
            uint8_t length =
                rrep.GetLength(); // Get the length of the rrep header excluding the type header
            dsrRoutingHeader.SetPayloadLength(length + 2);
            dsrRoutingHeader.AddDsrOption(rrep);
            Ptr<Packet> newPacket = Create<Packet>();
            newPacket->AddHeader(dsrRoutingHeader);
            dsr->ScheduleInitialReply(newPacket, ipv4Address, nextHop, m_ipv4Route);
            /*
             * Create the route entry to the rreq originator and save it to route cache, also need
             * to reverse the route
             */
            PrintVector(m_finalRoute);
            if (ReverseRoutes(m_finalRoute))
            {
                PrintVector(m_finalRoute);
                Ipv4Address dst = m_finalRoute.back();
                bool addRoute = false;
                if (numberAddress > 0)
                {
                    DsrRouteCacheEntry toSource(/*ip=*/m_finalRoute,
                                                /*dst=*/dst,
                                                /*exp=*/ActiveRouteTimeout);
                    if (dsr->IsLinkCache())
                    {
                        addRoute = dsr->AddRoute_Link(m_finalRoute, ipv4Address);
                    }
                    else
                    {
                        addRoute = dsr->AddRoute(toSource);
                    }
                }
                else
                {
                    NS_LOG_DEBUG("Abnormal RouteRequest");
                    return 0;
                }
 
                if (addRoute)
                {
                    /*
                     * Found a route to the dst, construct the source route option header
                     */
                    DsrOptionSRHeader sourceRoute;
                    NS_LOG_DEBUG("The route length " << m_finalRoute.size());
                    sourceRoute.SetNodesAddress(m_finalRoute);
 
                    /// TODO !!!!!!!!!!!!!!
                    /// Think about this part, we just added the route,
                    /// probability no need to increase stability now?????
                    // if (dsr->IsLinkCache ())
                    //   {
                    //     dsr->UseExtends (m_finalRoute);
                    //   }
                    sourceRoute.SetSegmentsLeft(m_finalRoute.size() - 2);
                    // The salvage value here is 0
                    sourceRoute.SetSalvage(0);
                    Ipv4Address nextHop =
                        SearchNextHop(ipv4Address, m_finalRoute); // Get the next hop address
                    NS_LOG_DEBUG("The nextHop address " << nextHop);
 
                    if (nextHop == "0.0.0.0")
                    {
                        dsr->PacketNewRoute(dsrP, ipv4Address, dst, protocol);
                        return 0;
                    }
                    SetRoute(nextHop, ipv4Address);
                    /*
                     * Send the data packet from the send buffer
                     */
                    dsr->SendPacketFromBuffer(sourceRoute, nextHop, protocol);
                    // Cancel the route request timer for destination after sending the data packet
                    dsr->CancelRreqTimer(dst, true);
                }
                else
                {
                    NS_LOG_DEBUG("The route is failed to add in cache");
                    return 0;
                }
            }
            else
            {
                NS_LOG_DEBUG("Unable to reverse route");
                return 0;
            }
            isPromisc = false;
            return rreq.GetSerializedSize();
        }
 
        /*
         * (ii) or it has an active route to the destination, send reply based on request header and
         * route cache, need to delay based on a random value from d = H * (h - 1 + r), which can
         * avoid possible route reply storm. Also, verify if two vectors do not contain duplicates
         * (part of the route to the destination from route cache and route collected so far). If
         * so, do not use the route found and forward the route request.
         */
        else if (isRouteInCache && !areThereDuplicates)
        {
            m_finalRoute.clear(); // Clear the final route vector
            /**
             * push back the intermediate node address from the source to this node
             */
            for (auto i = saveRoute.begin(); i != saveRoute.end(); ++i)
            {
                m_finalRoute.push_back(*i);
            }
            /**
             * push back the route vector we found in our route cache to destination, including this
             * node's address
             */
            for (auto j = ip.begin(); j != ip.end(); ++j)
            {
                m_finalRoute.push_back(*j);
            }
            /*
             * Create the route entry to the rreq originator and save it to route cache, also need
             * to reverse the route
             */
            bool addRoute = false;
            std::vector<Ipv4Address> reverseRoute(m_finalRoute);
 
            if (ReverseRoutes(reverseRoute))
            {
                saveRoute.push_back(ipv4Address);
                ReverseRoutes(saveRoute);
                Ipv4Address dst = saveRoute.back();
                NS_LOG_DEBUG("This is the route save in route cache");
                PrintVector(saveRoute);
 
                DsrRouteCacheEntry toSource(/*ip=*/saveRoute,
                                            /*dst=*/dst,
                                            /*exp=*/ActiveRouteTimeout);
                NS_ASSERT(saveRoute.front() == ipv4Address);
                // Add the route entry in the route cache
                if (dsr->IsLinkCache())
                {
                    addRoute = dsr->AddRoute_Link(saveRoute, ipv4Address);
                }
                else
                {
                    addRoute = dsr->AddRoute(toSource);
                }
 
                if (addRoute)
                {
                    NS_LOG_LOGIC("We have added the route and search send buffer for packet with "
                                 "destination "
                                 << dst);
                    /*
                     * Found a route the dst, construct the source route option header
                     */
                    DsrOptionSRHeader sourceRoute;
                    PrintVector(saveRoute);
 
                    sourceRoute.SetNodesAddress(saveRoute);
                    // if (dsr->IsLinkCache ())
                    //   {
                    //     dsr->UseExtends (saveRoute);
                    //   }
                    sourceRoute.SetSegmentsLeft(saveRoute.size() - 2);
                    uint8_t salvage = 0;
                    sourceRoute.SetSalvage(salvage);
                    Ipv4Address nextHop =
                        SearchNextHop(ipv4Address, saveRoute); // Get the next hop address
                    NS_LOG_DEBUG("The nextHop address " << nextHop);
 
                    if (nextHop == "0.0.0.0")
                    {
                        dsr->PacketNewRoute(dsrP, ipv4Address, dst, protocol);
                        return 0;
                    }
                    SetRoute(nextHop, ipv4Address);
                    /*
                     * Schedule the packet retry
                     */
                    dsr->SendPacketFromBuffer(sourceRoute, nextHop, protocol);
                    // Cancel the route request timer for destination
                    dsr->CancelRreqTimer(dst, true);
                }
                else
                {
                    NS_LOG_DEBUG("The route is failed to add in cache");
                    return 0;
                }
            }
            else
            {
                NS_LOG_DEBUG("Unable to reverse the route");
                return 0;
            }
 
            /*
             * Need to first pin down the next hop address before removing duplicates
             */
            Ipv4Address nextHop = ReverseSearchNextHop(ipv4Address, m_finalRoute);
            /*
             * First remove the duplicate ip address to automatically shorten the route, and then
             * reversely search the next hop address
             */
            // Set the route
            SetRoute(nextHop, ipv4Address);
 
            uint16_t hops = m_finalRoute.size();
            DsrOptionRrepHeader rrep;
            rrep.SetNodesAddress(m_finalRoute); // Set the node addresses in the route reply header
            // Get the real source of the reply
            Ipv4Address realSource = m_finalRoute.back();
            PrintVector(m_finalRoute);
            NS_LOG_DEBUG("This is the full route from " << realSource << " to "
                                                        << m_finalRoute.front());
            /*
             * This part add dsr header to the packet and send route reply packet
             */
            DsrRoutingHeader dsrRoutingHeader;
            dsrRoutingHeader.SetNextHeader(protocol);
            dsrRoutingHeader.SetMessageType(1);
            dsrRoutingHeader.SetSourceId(GetIDfromIP(realSource));
            dsrRoutingHeader.SetDestId(255);
 
            uint8_t length =
                rrep.GetLength(); // Get the length of the rrep header excluding the type header
            dsrRoutingHeader.SetPayloadLength(length + 2);
            dsrRoutingHeader.AddDsrOption(rrep);
            Ptr<Packet> newPacket = Create<Packet>();
            newPacket->AddHeader(dsrRoutingHeader);
            dsr->ScheduleCachedReply(newPacket, ipv4Address, nextHop, m_ipv4Route, hops);
            isPromisc = false;
            return rreq.GetSerializedSize();
        }
        /*
         * (iii) no route in any type has been found
         */
        else
        {
            mainVector.push_back(ipv4Address);
            NS_ASSERT(mainVector.front() == source);
            NS_LOG_DEBUG("Print out the main vector");
            PrintVector(mainVector);
            rreq.SetNodesAddress(mainVector);
 
            Ptr<Packet> errP = p->Copy();
            if (errP->GetSize())
            {
                NS_LOG_DEBUG("Error header included");
                DsrOptionRerrUnreachHeader rerr;
                p->RemoveHeader(rerr);
                Ipv4Address errorSrc = rerr.GetErrorSrc();
                Ipv4Address unreachNode = rerr.GetUnreachNode();
                Ipv4Address errorDst = rerr.GetErrorDst();
 
                if ((errorSrc == srcAddress) && (unreachNode == ipv4Address))
                {
                    NS_LOG_DEBUG("The error link back to work again");
                    uint16_t length = rreq.GetLength();
                    NS_LOG_DEBUG("The RREQ header length " << length);
                    dsrRoutingHeader.AddDsrOption(rreq);
                    dsrRoutingHeader.SetPayloadLength(length + 2);
                }
                else
                {
                    dsr->DeleteAllRoutesIncludeLink(errorSrc, unreachNode, ipv4Address);
 
                    DsrOptionRerrUnreachHeader newUnreach;
                    newUnreach.SetErrorType(1);
                    newUnreach.SetErrorSrc(errorSrc);
                    newUnreach.SetUnreachNode(unreachNode);
                    newUnreach.SetErrorDst(errorDst);
                    newUnreach.SetSalvage(rerr.GetSalvage()); // Set the value about whether to
                                                              // salvage a packet or not
                    uint16_t length = rreq.GetLength() + newUnreach.GetLength();
                    NS_LOG_DEBUG("The RREQ and newUnreach header length " << length);
                    dsrRoutingHeader.SetPayloadLength(length + 4);
                    dsrRoutingHeader.AddDsrOption(rreq);
                    dsrRoutingHeader.AddDsrOption(newUnreach);
                }
            }
            else
            {
                uint16_t length = rreq.GetLength();
                NS_LOG_DEBUG("The RREQ header length " << length);
                dsrRoutingHeader.AddDsrOption(rreq);
                dsrRoutingHeader.SetPayloadLength(length + 2);
            }
            // Get the TTL value
            uint8_t ttl = ipv4Header.GetTtl();
            /*
             * Decrease the TTL value in the packet tag by one, this tag will go to ip layer 3 send
             * function and drop packet when TTL value equals to 0
             */
            NS_LOG_DEBUG("The ttl value here " << (uint32_t)ttl);
            if (ttl)
            {
                Ptr<Packet> interP = Create<Packet>();
                SocketIpTtlTag tag;
                tag.SetTtl(ttl - 1);
                interP->AddPacketTag(tag);
                interP->AddHeader(dsrRoutingHeader);
                dsr->ScheduleInterRequest(interP);
                isPromisc = false;
            }
            return rreq.GetSerializedSize();
        }
    }
    // unreachable:  return rreq.GetSerializedSize ();
}
 
NS_OBJECT_ENSURE_REGISTERED(DsrOptionRrep);
 
TypeId
DsrOptionRrep::GetTypeId()
{
    static TypeId tid = TypeId("ns3::dsr::DsrOptionRrep")
                            .SetParent<DsrOptions>()
                            .SetGroupName("Dsr")
                            .AddConstructor<DsrOptionRrep>();
    return tid;
}
 
DsrOptionRrep::DsrOptionRrep()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
DsrOptionRrep::~DsrOptionRrep()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
uint8_t
DsrOptionRrep::GetOptionNumber() const
{
    NS_LOG_FUNCTION_NOARGS();
 
    return OPT_NUMBER;
}
 
uint8_t
DsrOptionRrep::Process(Ptr<Packet> packet,
                       Ptr<Packet> dsrP,
                       Ipv4Address ipv4Address,
                       Ipv4Address source,
                       const Ipv4Header& ipv4Header,
                       uint8_t protocol,
                       bool& isPromisc,
                       Ipv4Address promiscSource)
{
    NS_LOG_FUNCTION(this << packet << dsrP << ipv4Address << source << ipv4Header
                         << (uint32_t)protocol << isPromisc);
 
    Ptr<Packet> p = packet->Copy();
 
    // Get the number of routers' address field
    uint8_t buf[2];
    p->CopyData(buf, sizeof(buf));
    uint8_t numberAddress = (buf[1] - 2) / 4;
 
    DsrOptionRrepHeader rrep;
    rrep.SetNumberAddress(numberAddress); // Set the number of ip address in the header to reserver
                                          // space for deserialize header
    p->RemoveHeader(rrep);
 
    Ptr<Node> node = GetNodeWithAddress(ipv4Address);
    Ptr<dsr::DsrRouting> dsr = node->GetObject<dsr::DsrRouting>();
 
    NS_LOG_DEBUG("The next header value " << (uint32_t)protocol);
 
    std::vector<Ipv4Address> nodeList = rrep.GetNodesAddress();
    /**
     * Get the destination address, which is the last element in the nodeList
     */
    Ipv4Address targetAddress = nodeList.front();
    // If the RREP option has reached to the destination
    if (targetAddress == ipv4Address)
    {
        RemoveDuplicates(nodeList); // This is for the route reply from intermediate node since we
                                    // didn't remove duplicate there
        if (nodeList.empty())
        {
            NS_LOG_DEBUG("The route we have contains 0 entries");
            return 0;
        }
        /**
         * Get the destination address for the data packet, which is the last element in the
         * nodeList
         */
        Ipv4Address dst = nodeList.back();
        /**
         * Add the newly found route to the route cache
         * The route looks like:
         * \\ "srcAddress" + "intermediate node address" + "targetAddress"
         */
        DsrRouteCacheEntry toDestination(/*ip=*/nodeList,
                                         /*dst=*/dst,
                                         /*exp=*/ActiveRouteTimeout);
        NS_ASSERT(nodeList.front() == ipv4Address);
        bool addRoute = false;
        if (dsr->IsLinkCache())
        {
            addRoute = dsr->AddRoute_Link(nodeList, ipv4Address);
        }
        else
        {
            addRoute = dsr->AddRoute(toDestination);
        }
 
        if (addRoute)
        {
            NS_LOG_DEBUG(
                "We have added the route and search send buffer for packet with destination "
                << dst);
            /**
             * Found a route the dst, construct the source route option header
             */
            DsrOptionSRHeader sourceRoute;
            NS_LOG_DEBUG("The route length " << nodeList.size());
            sourceRoute.SetNodesAddress(nodeList);
            sourceRoute.SetSegmentsLeft(nodeList.size() - 2);
            sourceRoute.SetSalvage(0);
            Ipv4Address nextHop = SearchNextHop(ipv4Address, nodeList); // Get the next hop address
            NS_LOG_DEBUG("The nextHop address " << nextHop);
            if (nextHop == "0.0.0.0")
            {
                dsr->PacketNewRoute(dsrP, ipv4Address, dst, protocol);
                return 0;
            }
            PrintVector(nodeList);
            SetRoute(nextHop, ipv4Address);
            // Cancel the route request timer for destination
            dsr->CancelRreqTimer(dst, true);
            /**
             * Schedule the packet retry
             */
            dsr->SendPacketFromBuffer(sourceRoute, nextHop, protocol);
        }
        else
        {
            NS_LOG_DEBUG("Failed to add the route");
            return 0;
        }
    }
    else
    {
        uint8_t length = rrep.GetLength() -
                         2; // The get length - 2 is to get aligned for the malformed header check
        NS_LOG_DEBUG("The length of rrep option " << (uint32_t)length);
 
        if (length % 2 != 0)
        {
            NS_LOG_LOGIC("Malformed header. Drop!");
            m_dropTrace(packet);
            return 0;
        }
        PrintVector(nodeList);
        /*
         * This node is only an intermediate node, but it needs to save the possible route to the
         * destination when cutting the route
         */
        std::vector<Ipv4Address> routeCopy = nodeList;
        std::vector<Ipv4Address> cutRoute = CutRoute(ipv4Address, nodeList);
        PrintVector(cutRoute);
        if (cutRoute.size() >= 2)
        {
            Ipv4Address dst = cutRoute.back();
            NS_LOG_DEBUG("The route destination after cut " << dst);
            DsrRouteCacheEntry toDestination(/*ip=*/cutRoute,
                                             /*dst=*/dst,
                                             /*exp=*/ActiveRouteTimeout);
            NS_ASSERT(cutRoute.front() == ipv4Address);
            bool addRoute = false;
            if (dsr->IsLinkCache())
            {
                addRoute = dsr->AddRoute_Link(nodeList, ipv4Address);
            }
            else
            {
                addRoute = dsr->AddRoute(toDestination);
            }
            if (addRoute)
            {
                dsr->CancelRreqTimer(dst, true);
            }
            else
            {
                NS_LOG_DEBUG("The route not added");
            }
        }
        else
        {
            NS_LOG_DEBUG("The route is corrupted");
        }
        /*
         * Reverse search the vector for next hop address
         */
        Ipv4Address nextHop = ReverseSearchNextHop(ipv4Address, routeCopy);
        NS_ASSERT(routeCopy.back() == source);
        PrintVector(routeCopy);
        NS_LOG_DEBUG("The nextHop address " << nextHop << " and the source in the route reply "
                                            << source);
        /*
         * Set the route entry we will use to send reply
         */
        SetRoute(nextHop, ipv4Address);
        /*
         * This part add dsr routing header to the packet and send reply
         */
        DsrRoutingHeader dsrRoutingHeader;
        dsrRoutingHeader.SetNextHeader(protocol);
 
        length = rrep.GetLength(); // Get the length of the rrep header excluding the type header
        NS_LOG_DEBUG("The reply header length " << (uint32_t)length);
        dsrRoutingHeader.SetPayloadLength(length + 2);
        dsrRoutingHeader.SetMessageType(1);
        dsrRoutingHeader.SetSourceId(GetIDfromIP(source));
        dsrRoutingHeader.SetDestId(GetIDfromIP(targetAddress));
        dsrRoutingHeader.AddDsrOption(rrep);
        Ptr<Packet> newPacket = Create<Packet>();
        newPacket->AddHeader(dsrRoutingHeader);
        dsr->SendReply(newPacket, ipv4Address, nextHop, m_ipv4Route);
        isPromisc = false;
    }
    return rrep.GetSerializedSize();
}
 
NS_OBJECT_ENSURE_REGISTERED(DsrOptionSR);
 
TypeId
DsrOptionSR::GetTypeId()
{
    static TypeId tid = TypeId("ns3::dsr::DsrOptionSR")
                            .SetParent<DsrOptions>()
                            .SetGroupName("Dsr")
                            .AddConstructor<DsrOptionSR>();
    return tid;
}
 
DsrOptionSR::DsrOptionSR()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
DsrOptionSR::~DsrOptionSR()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
uint8_t
DsrOptionSR::GetOptionNumber() const
{
    NS_LOG_FUNCTION_NOARGS();
    return OPT_NUMBER;
}
 
uint8_t
DsrOptionSR::Process(Ptr<Packet> packet,
                     Ptr<Packet> dsrP,
                     Ipv4Address ipv4Address,
                     Ipv4Address source,
                     const Ipv4Header& ipv4Header,
                     uint8_t protocol,
                     bool& isPromisc,
                     Ipv4Address promiscSource)
{
    NS_LOG_FUNCTION(this << packet << dsrP << ipv4Address << source << ipv4Address << ipv4Header
                         << (uint32_t)protocol << isPromisc);
    Ptr<Packet> p = packet->Copy();
    // Get the number of routers' address field
    uint8_t buf[2];
    p->CopyData(buf, sizeof(buf));
    uint8_t numberAddress = (buf[1] - 2) / 4;
    DsrOptionSRHeader sourceRoute;
    sourceRoute.SetNumberAddress(numberAddress);
    p->RemoveHeader(sourceRoute);
 
    // The route size saved in the source route
    std::vector<Ipv4Address> nodeList = sourceRoute.GetNodesAddress();
    uint8_t segsLeft = sourceRoute.GetSegmentsLeft();
    uint8_t salvage = sourceRoute.GetSalvage();
    /*
     * Get the node from IP address and get the DSR extension object
     */
    Ptr<Node> node = GetNodeWithAddress(ipv4Address);
    Ptr<dsr::DsrRouting> dsr = node->GetObject<dsr::DsrRouting>();
    /*
     * Get the source and destination address from ipv4 header
     */
    Ipv4Address srcAddress = ipv4Header.GetSource();
    Ipv4Address destAddress = ipv4Header.GetDestination();
 
    // Get the node list destination
    Ipv4Address destination = nodeList.back();
    /*
     * If it's a promiscuous receive data packet,
     * 1. see if automatic route shortening possible or not
     * 2. see if it is a passive acknowledgment
     */
    if (isPromisc)
    {
        NS_LOG_LOGIC("We process promiscuous receipt data packet");
        if (ContainAddressAfter(ipv4Address, destAddress, nodeList))
        {
            NS_LOG_LOGIC("Send back the gratuitous reply");
            dsr->SendGratuitousReply(source, srcAddress, nodeList, protocol);
        }
 
        uint16_t fragmentOffset = ipv4Header.GetFragmentOffset();
        uint16_t identification = ipv4Header.GetIdentification();
 
        if (destAddress != destination)
        {
            NS_LOG_DEBUG("Process the promiscuously received packet");
            bool findPassive = false;
            int32_t nNodes = NodeList::GetNNodes();
            for (int32_t i = 0; i < nNodes; ++i)
            {
                NS_LOG_DEBUG("Working with node " << i);
 
                Ptr<Node> node = NodeList::GetNode(i);
                Ptr<dsr::DsrRouting> dsrNode = node->GetObject<dsr::DsrRouting>();
                // The source and destination addresses here are the real source and destination for
                // the packet
                findPassive = dsrNode->PassiveEntryCheck(packet,
                                                         source,
                                                         destination,
                                                         segsLeft,
                                                         fragmentOffset,
                                                         identification,
                                                         false);
                if (findPassive)
                {
                    break;
                }
            }
 
            if (findPassive)
            {
                NS_LOG_DEBUG("We find one previously received passive entry");
                /*
                 * Get the node from IP address and get the DSR extension object
                 * the srcAddress would be the source address from ip header
                 */
                PrintVector(nodeList);
 
                NS_LOG_DEBUG("promisc source " << promiscSource);
                Ptr<Node> node = GetNodeWithAddress(promiscSource);
                Ptr<dsr::DsrRouting> dsrSrc = node->GetObject<dsr::DsrRouting>();
                dsrSrc->CancelPassiveTimer(packet, source, destination, segsLeft);
            }
            else
            {
                NS_LOG_DEBUG("Saved the entry for further use");
                dsr->PassiveEntryCheck(packet,
                                       source,
                                       destination,
                                       segsLeft,
                                       fragmentOffset,
                                       identification,
                                       true);
            }
        }
        /// Safely terminate promiscuously received packet
        return 0;
    }
    else
    {
        /*
         * Get the number of address from the source route header
         */
        uint8_t length = sourceRoute.GetLength();
        uint8_t nextAddressIndex;
        Ipv4Address nextAddress;
 
        // Get the option type value
        uint32_t size = p->GetSize();
        auto data = new uint8_t[size];
        p->CopyData(data, size);
        uint8_t optionType = 0;
        optionType = *(data);
        /// When the option type is 160, means there is ACK request header after the source route,
        /// we need to send back acknowledgment
        if (optionType == 160)
        {
            NS_LOG_LOGIC("Remove the ack request header and add ack header to the packet");
            // Here we remove the ack packet to the previous hop
            DsrOptionAckReqHeader ackReq;
            p->RemoveHeader(ackReq);
            uint16_t ackId = ackReq.GetAckId();
            /*
             * Send back acknowledgment packet to the earlier hop
             * If the node list is not empty, find the previous hop from the node list,
             * otherwise, use srcAddress
             */
            Ipv4Address ackAddress = srcAddress;
            if (!nodeList.empty())
            {
                if (segsLeft > numberAddress) // The segmentsLeft field should not be larger than
                                              // the total number of ip addresses
                {
                    NS_LOG_LOGIC("Malformed header. Drop!");
                    m_dropTrace(packet);
                    return 0;
                }
                // -fstrict-overflow sensitive, see bug 1868
                if (numberAddress - segsLeft < 2) // The index is invalid
                {
                    NS_LOG_LOGIC("Malformed header. Drop!");
                    m_dropTrace(packet);
                    return 0;
                }
                ackAddress = nodeList[numberAddress - segsLeft - 2];
            }
            m_ipv4Route = SetRoute(ackAddress, ipv4Address);
            NS_LOG_DEBUG("Send back ACK to the earlier hop " << ackAddress << " from us "
                                                             << ipv4Address);
            dsr->SendAck(ackId, ackAddress, source, destination, protocol, m_ipv4Route);
        }
        /*
         * After send back ACK, check if the segments left value has turned to 0 or not, if yes,
         * update the route entry and return header length
         */
        if (segsLeft == 0)
        {
            NS_LOG_DEBUG("This is the final destination");
            isPromisc = false;
            return sourceRoute.GetSerializedSize();
        }
 
        if (length % 2 != 0)
        {
            NS_LOG_LOGIC("Malformed header. Drop!");
            m_dropTrace(packet);
            return 0;
        }
 
        if (segsLeft > numberAddress) // The segmentsLeft field should not be larger than the total
                                      // number of ip addresses
        {
            NS_LOG_LOGIC("Malformed header. Drop!");
            m_dropTrace(packet);
            return 0;
        }
 
        DsrOptionSRHeader newSourceRoute;
        newSourceRoute.SetSegmentsLeft(segsLeft - 1);
        newSourceRoute.SetSalvage(salvage);
        newSourceRoute.SetNodesAddress(nodeList);
        nextAddressIndex = numberAddress - segsLeft;
        nextAddress = newSourceRoute.GetNodeAddress(nextAddressIndex);
        NS_LOG_DEBUG("The next address of source route option "
                     << nextAddress << " and the nextAddressIndex: " << (uint32_t)nextAddressIndex
                     << " and the segments left : " << (uint32_t)segsLeft);
        /*
         * Get the target Address in the node list
         */
        Ipv4Address targetAddress = nodeList.back();
        Ipv4Address realSource = nodeList.front();
        /*
         * Search the vector for next hop address
         */
        Ipv4Address nextHop = SearchNextHop(ipv4Address, nodeList);
        PrintVector(nodeList);
 
        if (nextHop == "0.0.0.0")
        {
            NS_LOG_DEBUG("Before new packet " << *dsrP);
            dsr->PacketNewRoute(dsrP, realSource, targetAddress, protocol);
            return 0;
        }
 
        if (ipv4Address == nextHop)
        {
            NS_LOG_DEBUG("We have reached the destination");
            newSourceRoute.SetSegmentsLeft(0);
            return newSourceRoute.GetSerializedSize();
        }
        // Verify the multicast address, leave it here for now
        if (nextAddress.IsMulticast() || destAddress.IsMulticast())
        {
            m_dropTrace(packet);
            return 0;
        }
        // Set the route and forward the data packet
        SetRoute(nextAddress, ipv4Address);
        NS_LOG_DEBUG("dsr packet size " << dsrP->GetSize());
        dsr->ForwardPacket(dsrP,
                           newSourceRoute,
                           ipv4Header,
                           realSource,
                           nextAddress,
                           targetAddress,
                           protocol,
                           m_ipv4Route);
    }
    return sourceRoute.GetSerializedSize();
}
 
NS_OBJECT_ENSURE_REGISTERED(DsrOptionRerr);
 
TypeId
DsrOptionRerr::GetTypeId()
{
    static TypeId tid = TypeId("ns3::dsr::DsrOptionRerr")
                            .SetParent<DsrOptions>()
                            .SetGroupName("Dsr")
                            .AddConstructor<DsrOptionRerr>();
    return tid;
}
 
DsrOptionRerr::DsrOptionRerr()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
DsrOptionRerr::~DsrOptionRerr()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
uint8_t
DsrOptionRerr::GetOptionNumber() const
{
    NS_LOG_FUNCTION_NOARGS();
    return OPT_NUMBER;
}
 
uint8_t
DsrOptionRerr::Process(Ptr<Packet> packet,
                       Ptr<Packet> dsrP,
                       Ipv4Address ipv4Address,
                       Ipv4Address source,
                       const Ipv4Header& ipv4Header,
                       uint8_t protocol,
                       bool& isPromisc,
                       Ipv4Address promiscSource)
{
    NS_LOG_FUNCTION(this << packet << dsrP << ipv4Address << source << ipv4Header
                         << (uint32_t)protocol << isPromisc);
    Ptr<Packet> p = packet->Copy();
    uint32_t size = p->GetSize();
    auto data = new uint8_t[size];
    p->CopyData(data, size);
    uint8_t errorType = *(data + 2);
    /*
     * Get the node from Ip address and get the dsr extension object
     */
    Ptr<Node> node = GetNodeWithAddress(ipv4Address);
    Ptr<dsr::DsrRouting> dsr = node->GetObject<dsr::DsrRouting>();
    NS_LOG_DEBUG("The error type value here " << (uint32_t)errorType);
    if (errorType == 1) // unreachable ip address
    {
        /*
         * Remove the route error header from the packet, and get the error type
         */
        DsrOptionRerrUnreachHeader rerrUnreach;
        p->RemoveHeader(rerrUnreach);
        /*
         * Get the error destination address
         */
        Ipv4Address unreachAddress = rerrUnreach.GetUnreachNode();
        Ipv4Address errorSource = rerrUnreach.GetErrorSrc();
 
        NS_LOG_DEBUG("The error source is " << rerrUnreach.GetErrorDst()
                                            << "and the unreachable node is " << unreachAddress);
        /*
         * Get the serialized size of the rerr header
         */
        uint32_t rerrSize = rerrUnreach.GetSerializedSize();
        /*
         * Delete all the routes including the unreachable node address from the route cache
         */
        Ptr<Node> node = GetNodeWithAddress(ipv4Address);
        dsr->DeleteAllRoutesIncludeLink(errorSource, unreachAddress, ipv4Address);
 
        Ptr<Packet> newP = p->Copy();
        uint32_t serialized = DoSendError(newP, rerrUnreach, rerrSize, ipv4Address, protocol);
        return serialized;
    }
    else
    {
        /*
         * Two other type of error headers:
         * 1. flow state not supported type-specific information
         * 2. unsupported option with option number
         */
        /*
         * Remove the route error header from the packet, and get the error type
         */
        DsrOptionRerrUnsupportedHeader rerrUnsupported;
        p->RemoveHeader(rerrUnsupported);
 
        /// @todo This is for the other two error options, not supporting for now
        // uint32_t rerrSize = rerrUnsupported.GetSerializedSize();
        // uint32_t serialized = DoSendError (p, rerrUnsupported, rerrSize, ipv4Address, protocol);
        uint32_t serialized = 0;
        return serialized;
    }
}
 
uint8_t
DsrOptionRerr::DoSendError(Ptr<Packet> p,
                           DsrOptionRerrUnreachHeader& rerr,
                           uint32_t rerrSize,
                           Ipv4Address ipv4Address,
                           uint8_t protocol)
{
    // Get the number of routers' address field
    uint8_t buf[2];
    p->CopyData(buf, sizeof(buf));
    uint8_t numberAddress = (buf[1] - 2) / 4;
 
    // Here remove the source route header and schedule next hop error transmission
    NS_LOG_DEBUG("The number of addresses " << (uint32_t)numberAddress);
    DsrOptionSRHeader sourceRoute;
    sourceRoute.SetNumberAddress(numberAddress);
    p->RemoveHeader(sourceRoute);
    NS_ASSERT(p->GetSize() == 0);
    /*
     * Get the node from ip address and the dsr extension object
     */
    Ptr<Node> node = GetNodeWithAddress(ipv4Address);
    Ptr<dsr::DsrRouting> dsr = node->GetObject<dsr::DsrRouting>();
    /*
     * Get the segments left field and the next address
     */
    uint8_t segmentsLeft = sourceRoute.GetSegmentsLeft();
    uint8_t length = sourceRoute.GetLength();
    uint8_t nextAddressIndex;
    Ipv4Address nextAddress;
    /*
     * Get the route size and the error target address
     */
    std::vector<Ipv4Address> nodeList = sourceRoute.GetNodesAddress();
    Ipv4Address targetAddress = nodeList.back();
    /*
     * The total serialized size for both the rerr and source route headers
     */
    uint32_t serializedSize = rerrSize + sourceRoute.GetSerializedSize();
 
    if (length % 2 != 0)
    {
        NS_LOG_LOGIC("Malformed header. Drop!");
        m_dropTrace(p);
        return 0;
    }
 
    if (segmentsLeft > numberAddress)
    {
        NS_LOG_LOGIC("Malformed header. Drop!");
        m_dropTrace(p);
        return 0;
    }
    /*
     * When the error packet has reached to the destination
     */
    if (segmentsLeft == 0 && targetAddress == ipv4Address)
    {
        NS_LOG_INFO("This is the destination of the error, send error request");
        dsr->SendErrorRequest(rerr, protocol);
        return serializedSize;
    }
 
    // Get the next Router Address
    DsrOptionSRHeader newSourceRoute;
    newSourceRoute.SetSegmentsLeft(segmentsLeft - 1);
    nextAddressIndex = numberAddress - segmentsLeft;
    nextAddress = sourceRoute.GetNodeAddress(nextAddressIndex);
    newSourceRoute.SetSalvage(sourceRoute.GetSalvage());
    newSourceRoute.SetNodesAddress(nodeList);
    nextAddress = newSourceRoute.GetNodeAddress(nextAddressIndex);
 
    /// to test if the next address is multicast or not
    if (nextAddress.IsMulticast() || targetAddress.IsMulticast())
    {
        m_dropTrace(p);
        return serializedSize;
    }
 
    // Set the route entry
    SetRoute(nextAddress, ipv4Address);
    dsr->ForwardErrPacket(rerr, newSourceRoute, nextAddress, protocol, m_ipv4Route);
    return serializedSize;
}
 
NS_OBJECT_ENSURE_REGISTERED(DsrOptionAckReq);
 
TypeId
DsrOptionAckReq::GetTypeId()
{
    static TypeId tid = TypeId("ns3::dsr::DsrOptionAckReq")
                            .SetParent<DsrOptions>()
                            .SetGroupName("Dsr")
                            .AddConstructor<DsrOptionAckReq>();
    return tid;
}
 
DsrOptionAckReq::DsrOptionAckReq()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
DsrOptionAckReq::~DsrOptionAckReq()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
uint8_t
DsrOptionAckReq::GetOptionNumber() const
{
    NS_LOG_FUNCTION_NOARGS();
    return OPT_NUMBER;
}
 
uint8_t
DsrOptionAckReq::Process(Ptr<Packet> packet,
                         Ptr<Packet> dsrP,
                         Ipv4Address ipv4Address,
                         Ipv4Address source,
                         const Ipv4Header& ipv4Header,
                         uint8_t protocol,
                         bool& isPromisc,
                         Ipv4Address promiscSource)
{
    NS_LOG_FUNCTION(this << packet << dsrP << ipv4Address << source << ipv4Header
                         << (uint32_t)protocol << isPromisc);
    /*
     * Current implementation of the ack request header processing is coded in source route header
     * processing
     */
    /*
     * Remove the ack request header
     */
    Ptr<Packet> p = packet->Copy();
    DsrOptionAckReqHeader ackReq;
    p->RemoveHeader(ackReq);
    /*
     * Get the node with ip address and get the dsr extension and route cache objects
     */
    Ptr<Node> node = GetNodeWithAddress(ipv4Address);
    Ptr<dsr::DsrRouting> dsr = node->GetObject<dsr::DsrRouting>();
 
    NS_LOG_DEBUG("The next header value " << (uint32_t)protocol);
 
    return ackReq.GetSerializedSize();
}
 
NS_OBJECT_ENSURE_REGISTERED(DsrOptionAck);
 
TypeId
DsrOptionAck::GetTypeId()
{
    static TypeId tid = TypeId("ns3::dsr::DsrOptionAck")
                            .SetParent<DsrOptions>()
                            .SetGroupName("Dsr")
                            .AddConstructor<DsrOptionAck>();
    return tid;
}
 
DsrOptionAck::DsrOptionAck()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
DsrOptionAck::~DsrOptionAck()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
uint8_t
DsrOptionAck::GetOptionNumber() const
{
    NS_LOG_FUNCTION_NOARGS();
    return OPT_NUMBER;
}
 
uint8_t
DsrOptionAck::Process(Ptr<Packet> packet,
                      Ptr<Packet> dsrP,
                      Ipv4Address ipv4Address,
                      Ipv4Address source,
                      const Ipv4Header& ipv4Header,
                      uint8_t protocol,
                      bool& isPromisc,
                      Ipv4Address promiscSource)
{
    NS_LOG_FUNCTION(this << packet << dsrP << ipv4Address << source << ipv4Header
                         << (uint32_t)protocol << isPromisc);
    /*
     * Remove the ACK header
     */
    Ptr<Packet> p = packet->Copy();
    DsrOptionAckHeader ack;
    p->RemoveHeader(ack);
    /*
     * Get the ACK source and destination address
     */
    Ipv4Address realSrc = ack.GetRealSrc();
    Ipv4Address realDst = ack.GetRealDst();
    uint16_t ackId = ack.GetAckId();
    /*
     * Get the node with ip address and get the dsr extension and route cache objects
     */
    Ptr<Node> node = GetNodeWithAddress(ipv4Address);
    Ptr<dsr::DsrRouting> dsr = node->GetObject<dsr::DsrRouting>();
    dsr->UpdateRouteEntry(realDst);
    /*
     * Cancel the packet retransmit timer when receiving the ack packet
     */
    dsr->CallCancelPacketTimer(ackId, ipv4Header, realSrc, realDst);
    return ack.GetSerializedSize();
}
 
} // namespace dsr
} // namespace ns3