sixlowpan-hc1-test.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2013 Universita' di Firenze, Italy
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
 */
 
#include "ns3/boolean.h"
#include "ns3/enum.h"
#include "ns3/inet6-socket-address.h"
#include "ns3/internet-stack-helper.h"
#include "ns3/log.h"
#include "ns3/node.h"
#include "ns3/simple-channel.h"
#include "ns3/simple-net-device.h"
#include "ns3/simulator.h"
#include "ns3/sixlowpan-net-device.h"
#include "ns3/socket-factory.h"
#include "ns3/socket.h"
#include "ns3/test.h"
#include "ns3/udp-socket-factory.h"
 
#include <limits>
#include <string>
 
using namespace ns3;
 
/**
 * @ingroup sixlowpan-tests
 *
 * @brief 6LoWPAN HC1 Test
 */
class SixlowpanHc1ImplTest : public TestCase
{
    Ptr<Packet> m_receivedPacket; //!< received packet
 
    /**
     * Send data function.
     *
     * @param socket The sending socket.
     * @param to The destination.
     */
    void DoSendData(Ptr<Socket> socket, std::string to);
 
    /**
     * Send data function.
     *
     * @param socket The sending socket.
     * @param to The destination.
     */
    void SendData(Ptr<Socket> socket, std::string to);
 
  public:
    void DoRun() override;
    SixlowpanHc1ImplTest();
 
    /**
     * Packet receive function.
     *
     * @param socket The receiving socket.
     * @param packet The received packet.
     * @param from The sender.
     */
    void ReceivePacket(Ptr<Socket> socket, Ptr<Packet> packet, const Address& from);
    /**
     * Packet receive function.
     *
     * @param socket The receiving socket.
     */
    void ReceivePkt(Ptr<Socket> socket);
};
 
SixlowpanHc1ImplTest::SixlowpanHc1ImplTest()
    : TestCase("Sixlowpan implementation")
{
}
 
void
SixlowpanHc1ImplTest::ReceivePacket(Ptr<Socket> socket, Ptr<Packet> packet, const Address& from)
{
    m_receivedPacket = packet;
}
 
void
SixlowpanHc1ImplTest::ReceivePkt(Ptr<Socket> socket)
{
    uint32_t availableData [[maybe_unused]] = socket->GetRxAvailable();
    m_receivedPacket = socket->Recv(std::numeric_limits<uint32_t>::max(), 0);
    NS_ASSERT(availableData == m_receivedPacket->GetSize());
}
 
void
SixlowpanHc1ImplTest::DoSendData(Ptr<Socket> socket, std::string to)
{
    Address realTo = Inet6SocketAddress(Ipv6Address(to.c_str()), 1234);
    uint8_t buffer[] = "\"Can you tell me where my country lies?\" \\ said the unifaun to his true "
                       "love's eyes. \\ \"It lies with me!\" cried the Queen of Maybe \\ - for her "
                       "merchandise, he traded in his prize.";
 
    Ptr<Packet> packet = Create<Packet>(buffer, 180);
    NS_TEST_EXPECT_MSG_EQ(socket->SendTo(packet, 0, realTo), 180, "200");
}
 
void
SixlowpanHc1ImplTest::SendData(Ptr<Socket> socket, std::string to)
{
    m_receivedPacket = Create<Packet>();
    Simulator::ScheduleWithContext(socket->GetNode()->GetId(),
                                   Seconds(0),
                                   &SixlowpanHc1ImplTest::DoSendData,
                                   this,
                                   socket,
                                   to);
    Simulator::Run();
}
 
void
SixlowpanHc1ImplTest::DoRun()
{
    // Create topology
    InternetStackHelper internet;
    internet.SetIpv4StackInstall(false);
 
    // Receiver Node
    Ptr<Node> rxNode = CreateObject<Node>();
    internet.Install(rxNode);
    Ptr<SimpleNetDevice> rxDev;
    { // first interface
        rxDev = CreateObject<SimpleNetDevice>();
        rxDev->SetAddress(Mac48Address::ConvertFrom(Mac48Address::Allocate()));
        rxNode->AddDevice(rxDev);
 
        Ptr<SixLowPanNetDevice> rxSix = CreateObject<SixLowPanNetDevice>();
        rxSix->SetAttribute("CompressionType", EnumValue(SixLowPanNetDevice::HC1));
        rxNode->AddDevice(rxSix);
        rxSix->SetNetDevice(rxDev);
 
        Ptr<Ipv6> ipv6 = rxNode->GetObject<Ipv6>();
        ipv6->AddInterface(rxDev);
        uint32_t netdev_idx = ipv6->AddInterface(rxSix);
        Ipv6InterfaceAddress ipv6Addr =
            Ipv6InterfaceAddress(Ipv6Address("2001:0100::1"), Ipv6Prefix(64));
        ipv6->AddAddress(netdev_idx, ipv6Addr);
        ipv6->SetUp(netdev_idx);
    }
 
    // Sender Node
    Ptr<Node> txNode = CreateObject<Node>();
    internet.Install(txNode);
    Ptr<SimpleNetDevice> txDev;
    {
        txDev = CreateObject<SimpleNetDevice>();
        txDev->SetAddress(Mac48Address::ConvertFrom(Mac48Address::Allocate()));
        txNode->AddDevice(txDev);
 
        Ptr<SixLowPanNetDevice> txSix = CreateObject<SixLowPanNetDevice>();
        txSix->SetAttribute("CompressionType", EnumValue(SixLowPanNetDevice::HC1));
        txNode->AddDevice(txSix);
        txSix->SetNetDevice(txDev);
 
        Ptr<Ipv6> ipv6 = txNode->GetObject<Ipv6>();
        ipv6->AddInterface(txDev);
        uint32_t netdev_idx = ipv6->AddInterface(txSix);
        Ipv6InterfaceAddress ipv6Addr =
            Ipv6InterfaceAddress(Ipv6Address("2001:0100::2"), Ipv6Prefix(64));
        ipv6->AddAddress(netdev_idx, ipv6Addr);
        ipv6->SetUp(netdev_idx);
    }
 
    // link the two nodes
    Ptr<SimpleChannel> channel1 = CreateObject<SimpleChannel>();
    rxDev->SetChannel(channel1);
    txDev->SetChannel(channel1);
 
    // Create the UDP sockets
    Ptr<SocketFactory> rxSocketFactory = rxNode->GetObject<UdpSocketFactory>();
    Ptr<Socket> rxSocket = rxSocketFactory->CreateSocket();
    NS_TEST_EXPECT_MSG_EQ(rxSocket->Bind(Inet6SocketAddress(Ipv6Address("2001:0100::1"), 1234)),
                          0,
                          "trivial");
    rxSocket->SetRecvCallback(MakeCallback(&SixlowpanHc1ImplTest::ReceivePkt, this));
 
    Ptr<SocketFactory> txSocketFactory = txNode->GetObject<UdpSocketFactory>();
    Ptr<Socket> txSocket = txSocketFactory->CreateSocket();
    txSocket->SetAllowBroadcast(true);
    // ------ Now the tests ------------
 
    // Unicast test
    SendData(txSocket, "2001:0100::1");
    NS_TEST_EXPECT_MSG_EQ(m_receivedPacket->GetSize(), 180, "trivial");
    uint8_t rxBuffer[180];
    uint8_t txBuffer[180] = "\"Can you tell me where my country lies?\" \\ said the unifaun to his "
                            "true love's eyes. \\ \"It lies with me!\" cried the Queen of Maybe \\ "
                            "- for her merchandise, he traded in his prize.";
    m_receivedPacket->CopyData(rxBuffer, 180);
    NS_TEST_EXPECT_MSG_EQ(memcmp(rxBuffer, txBuffer, 180), 0, "trivial");
 
    m_receivedPacket->RemoveAllByteTags();
 
    Simulator::Destroy();
}
 
/**
 * @ingroup sixlowpan-tests
 *
 * @brief 6LoWPAN HC1 TestSuite
 */
class SixlowpanHc1TestSuite : public TestSuite
{
  public:
    SixlowpanHc1TestSuite();
 
  private:
};
 
SixlowpanHc1TestSuite::SixlowpanHc1TestSuite()
    : TestSuite("sixlowpan-hc1", Type::UNIT)
{
    AddTestCase(new SixlowpanHc1ImplTest(), TestCase::Duration::QUICK);
}
 
static SixlowpanHc1TestSuite g_sixlowpanHc1TestSuite; //!< Static variable for test initialization