F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fd-net-device: Add dpdk-net-device examples

Browse Source 
Examples added:
	* fd-dpdk-emu-ping : Ping application
	* fd-dpdk-emu-onoff : OnOff application

Co-authored-by: Harsh Patel <thadodaharsh10@gmail.com>
Co-authored-by: Mohit P. Tahiliani <tahiliani@nitk.edu.in>
This commit is contained in:
Hrishikesh Hiraskar
2019-03-20 12:39:01 +05:30
committed by Tom Henderson
parent 859eea3c22
commit 1e9f448409
3 changed files with 561 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

291
src/fd-net-device/examples/fd-dpdk-emu-onoff.cc Normal file
View File

@@ -0,0 +1,291 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2019 NITK Surathkal
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Harsh Patel <thadodaharsh10@gmail.com>
* Hrishikesh Hiraskar <hrishihiraskar@gmail.com>
* Mohit P. Tahiliani <tahiliani@nitk.edu.in>
*/
// +----------------------+ +-----------------------+
// | client host | | server host |
// +----------------------+ +-----------------------+
// | ns-3 Node 0 | | ns-3 Node 1 |
// | +----------------+ | | +----------------+ |
// | | ns-3 TCP | | | | ns-3 TCP | |
// | +----------------+ | | +----------------+ |
// | | ns-3 IPv4 | | | | ns-3 IPv4 | |
// | +----------------+ | | +----------------+ |
// | | FdNetDevice | | | | FdNetDevice | |
// | | or | | | | or | |
// | | DpdkNetDevice | | | | DpdkNetDevice | |
// | | 10.1.1.1 | | | | 10.1.1.2 | |
// | +----------------+ | | +----------------+ |
// | | raw socket | | | | raw socket | |
// | | or | | | | or | |
// | | EAL | | | | EAL | |
// | +----------------+ | | +----------------+ |
// | | eth0 | | | | eth0 | |
// | | or | | | | or | |
// | | 0000:00.1f | | | | 0000:00.1f | |
// +----+------------+----+ +-----+------------+----+
//
// 10.1.1.11 10.1.1.12
//
// | |
// +----------------------------+
//
// This example is aimed at measuring the throughput of the FdNetDevice or
// DpdkNetDevice (if dpdkMode is true) when using the EmuFdNetDeviceHelper.
// This is achieved by saturating the channel with TCP traffic. Then the
// throughput can be obtained from the generated .pcap files.
//
// To run this example you will need two hosts (client & server).
// Steps to run the experiment:
//
// 1 - Connect the 2 computers with an Ethernet cable.
//
// 2 - Set the IP addresses on both Ethernet devices.
//
// client machine: $ sudo ip addr add dev eth0 10.1.1.11/24
// server machine: $ sudo ip addr add dev eth0 10.1.1.12/24
//
// 3 - The NetDevice will be one of FdNetDevice or DpdkNetDevice based on the
// the value of dpdkMode parameter.
//
// 4 - In case of FdNetDevice, set both Ethernet devices to promiscuous mode.
//
// both machines: $ sudo ip link set eth0 promisc on
//
// 5 - In case of FdNetDevice, give root suid to the raw socket creator binary.
// If the --enable-sudo option was used to configure ns-3 with waf, then the following
// step will not be necessary.
//
// both hosts: $ sudo chown root.root build/src/fd-net-device/ns3-dev-raw-sock-creator
// both hosts: $ sudo chmod 4755 build/src/fd-net-device/ns3-dev-raw-sock-creator
//
// 6 - In case of DpdkNetDevice, use device address instead of device name
//
// For example: 0000:00:1f.6 (can be obtained by lspci)
//
// 7 - Run the server side:
//
// server host: $ ./waf --run="fd-emu-onoff --serverMode=1 --dpdkMode=true"
//
// 8 - Run the client side:
//
// client host: $ ./waf --run="fd-emu-onoff --dpdkMode=true"
//
// NOTE: You can also use iperf as client or server.
//
#include <iostream>
#include <fstream>
#include <vector>
#include <string>
#include "ns3/core-module.h"
#include "ns3/network-module.h"
#include "ns3/internet-module.h"
#include "ns3/applications-module.h"
#include "ns3/config-store-module.h"
#include "ns3/fd-net-device-module.h"
#include "ns3/internet-apps-module.h"
#include "ns3/traffic-control-module.h"
using namespace ns3;
NS_LOG_COMPONENT_DEFINE("EmuFdNetDeviceSaturationExample");
int main(int argc, char *argv[])
{
uint16_t sinkPort = 8000;
uint32_t packetSize = 190; // bytes
std::string dataRate("950Mb/s");
bool serverMode = false;
std::string deviceName("eno1");
std::string client("10.0.1.11");
std::string server("10.0.1.22");
std::string netmask("255.255.255.0");
std::string macClient("00:00:00:00:00:01");
std::string macServer("00:00:00:00:00:02");
std::string transportProt = "Udp";
std::string socketType;
bool dpdkMode = true;
bool ping = false;
int dpdkTimeout = 2000;
double samplingPeriod = 0.5; // s
CommandLine cmd;
cmd.AddValue("deviceName", "Device name", deviceName);
cmd.AddValue("client", "Local IP address (dotted decimal only please)", client);
cmd.AddValue("server", "Remote IP address (dotted decimal only please)", server);
cmd.AddValue("localmask", "Local mask address (dotted decimal only please)", netmask);
cmd.AddValue("serverMode", "1:true, 0:false, default client", serverMode);
cmd.AddValue("macClient", "Mac Address for Client. Default : 00:00:00:00:00:01", macClient);
cmd.AddValue("macServer", "Mac Address for Server. Default : 00:00:00:00:00:02", macServer);
cmd.AddValue("dataRate", "Data rate defaults to 1000Mb/s", dataRate);
cmd.AddValue("transportPort", "Transport protocol to use: Tcp, Udp", transportProt);
cmd.AddValue("dpdkMode", "Enable the netmap emulation mode", dpdkMode);
cmd.AddValue("dpdkTimeout", "Tx Timeout to use in dpdkMode. (in microseconds)", dpdkTimeout);
cmd.AddValue("ping", "Enable server ping client side", ping);
cmd.AddValue("packetSize", "Size of the packet (without header) in bytes.", packetSize);
cmd.Parse(argc, argv);
Ipv4Address remoteIp;
Ipv4Address localIp;
Mac48AddressValue localMac;
if (serverMode)
{
remoteIp = Ipv4Address(client.c_str());
localIp = Ipv4Address(server.c_str());
localMac = Mac48AddressValue(macServer.c_str());
}
else
{
remoteIp = Ipv4Address(server.c_str());
localIp = Ipv4Address(client.c_str());
localMac = Mac48AddressValue(macClient.c_str());
}
if (transportProt.compare("Tcp") == 0)
{
socketType = "ns3::TcpSocketFactory";
}
else
{
socketType = "ns3::UdpSocketFactory";
}
Ipv4Mask localMask(netmask.c_str());
GlobalValue::Bind("SimulatorImplementationType", StringValue("ns3::RealtimeSimulatorImpl"));
GlobalValue::Bind("ChecksumEnabled", BooleanValue(true));
Config::SetDefault("ns3::TcpSocketBase::Sack", BooleanValue(true));
NS_LOG_INFO("Create Node");
Ptr<Node> node = CreateObject<Node>();
NS_LOG_INFO("Create Device");
EmuFdNetDeviceHelper emu;
// set the dpdk emulation mode
if (dpdkMode)
{
// set the dpdk emulation mode
char **ealArgv = new char*[20];
// arg[0] is program name (optional)
ealArgv[0] = new char[20];
strcpy (ealArgv[0], "");
// logical core usage
ealArgv[1] = new char[20];
strcpy (ealArgv[1], "-l");
// Use core 0 and 1
ealArgv[2] = new char[20];
strcpy (ealArgv[2], "0,1");
// Load library
ealArgv[3] = new char[20];
strcpy (ealArgv[3], "-d");
// Use e1000 driver library
ealArgv[4] = new char[20];
strcpy (ealArgv[4], "librte_pmd_e1000.so");
// Load library
ealArgv[5] = new char[20];
strcpy (ealArgv[5], "-d");
// Use mempool ring library
ealArgv[6] = new char[50];
strcpy (ealArgv[6], "librte_mempool_ring.so");
emu.SetDpdkMode(7, ealArgv);
}
emu.SetDeviceName(deviceName);
NetDeviceContainer devices = emu.Install(node);
Ptr<NetDevice> device = devices.Get(0);
device->SetAttribute("Address", localMac);
if (dpdkMode)
{
device->SetAttribute("TxTimeout", UintegerValue (dpdkTimeout) );
}
NS_LOG_INFO("Add Internet Stack");
InternetStackHelper internetStackHelper;
internetStackHelper.SetIpv4StackInstall(true);
internetStackHelper.Install(node);
NS_LOG_INFO("Create IPv4 Interface");
Ptr<Ipv4> ipv4 = node->GetObject<Ipv4>();
uint32_t interface = ipv4->AddInterface(device);
Ipv4InterfaceAddress address = Ipv4InterfaceAddress(localIp, localMask);
ipv4->AddAddress(interface, address);
ipv4->SetMetric(interface, 1);
ipv4->SetUp(interface);
Config::SetDefault("ns3::TcpSocket::SegmentSize", UintegerValue(packetSize));
if (serverMode)
{
Address sinkLocalAddress(InetSocketAddress(localIp, sinkPort));
PacketSinkHelper sinkHelper(socketType, sinkLocalAddress);
ApplicationContainer sinkApp = sinkHelper.Install(node);
sinkApp.Start(Seconds(1));
sinkApp.Stop(Seconds(30.0));
emu.EnablePcap("fd-server", device);
}
else
{
// add traffic generator
AddressValue remoteAddress(InetSocketAddress(remoteIp, sinkPort));
OnOffHelper onoff(socketType, Address());
onoff.SetAttribute("Remote", remoteAddress);
onoff.SetAttribute("OnTime", StringValue("ns3::ConstantRandomVariable[Constant=1]"));
onoff.SetAttribute("OffTime", StringValue("ns3::ConstantRandomVariable[Constant=0]"));
onoff.SetAttribute("DataRate", DataRateValue(dataRate));
onoff.SetAttribute("PacketSize", UintegerValue(packetSize));
ApplicationContainer clientApps = onoff.Install(node);
clientApps.Start(Seconds(6.0));
clientApps.Stop(Seconds(106.0));
if (ping)
{
printf("Adding ping app\n");
// add ping application
Ptr<V4Ping> app = CreateObject<V4Ping>();
app->SetAttribute("Remote", Ipv4AddressValue(remoteIp));
app->SetAttribute("Verbose", BooleanValue(true));
app->SetAttribute("Interval", TimeValue(Seconds(samplingPeriod)));
node->AddApplication(app);
app->SetStartTime(Seconds(6.0));
app->SetStopTime(Seconds(106.0));
}
emu.EnablePcap("fd-client", device);
}
Simulator::Stop(Seconds(120));
Simulator::Run();
Simulator::Destroy();
return 0;
}

264
src/fd-net-device/examples/fd-dpdk-emu-ping.cc Normal file
View File

@@ -0,0 +1,264 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2019 NITK Surathkal
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Harsh Patel <thadodaharsh10@gmail.com>
* Hrishikesh Hiraskar <hrishihiraskar@gmail.com>
* Mohit P. Tahiliani <tahiliani@nitk.edu.in>
*/
// Allow ns-3 to ping a real host somewhere, using DPDK emulation mode
//
// +----------------------+
// | host |
// +----------------------+
// | ns-3 simulation |
// +----------------------+
// | ns-3 Node |
// | +----------------+ |
// | | ns-3 TCP | |
// | +----------------+ |
// | | ns-3 IPv4 | |
// | +----------------+ |
// | | FdNetDevice | |
// | | or | |
// | | DpdkNetDevice | |
// |--+----------------+--+
// | | 'eth0' or | |
// | | '0000:00.1f.6' | |
// | +----------------+ |
// | | |
// +----------|-----------+
// |
// | +---------+
// .---------| GW host |--- (Internet) -----
// +---------+
//
/// To use this example:
// 1) You need to decide on a physical device on your real system, and either
// overwrite the hard-configured device address below (0000:00.1f.6) or pass
// this device addresss in as a command-line argument. This address can be
// obtained by doing `lspci`.
// 2) (Optional) You can add your device Mac address to macClient. This is
// required if mac spoofing is not allowed in network.
// 3) You will need to assign an IP address to the ns-3 simulation node that
// is consistent with the subnet that is active on the host device's link.
// That is, you will have to assign an IP address to the ns-3 node as if
// it were on your real subnet. Search for "Ipv4Address localIp" and
// replace the string "1.2.3.4" with a valid IP address.
// 4) You will need to configure a default route in the ns-3 node to tell it
// how to get off of your subnet. One thing you could do is a
// 'netstat -rn' command and find the IP address of the default gateway
// on your host. Search for "Ipv4Address gateway" and replace the string
// "1.2.3.4" string with the gateway IP address.
//
#include "ns3/abort.h"
#include "ns3/core-module.h"
#include "ns3/internet-module.h"
#include "ns3/network-module.h"
#include "ns3/fd-net-device-module.h"
#include "ns3/internet-apps-module.h"
#include "ns3/ipv4-static-routing-helper.h"
#include "ns3/ipv4-list-routing-helper.h"
#include "ns3/applications-module.h"
#include "ns3/traffic-control-module.h"
using namespace ns3;
NS_LOG_COMPONENT_DEFINE ("DpdkEmulationPingExample");
static void
PingRtt (std::string context, Time rtt)
{
NS_LOG_UNCOND ("Received Response with RTT = " << rtt);
}
int
main (int argc, char *argv[])
{
NS_LOG_INFO ("Dpdk Emulation Ping Example");
std::string deviceName ("0000:00:1f.6");
std::string macClient("78:0c:b8:d8:e1:95");
// ping a real host connected back-to-back through the ethernet interfaces
std::string remote ("192.168.43.2");
double samplingPeriod = 0.5; // s
CommandLine cmd;
cmd.AddValue ("deviceName", "Device address to use (Eg: 0000:00:1f.6). Use `lspci` to find this.", deviceName);
cmd.AddValue ("remote", "Remote IP address (dotted decimal only please)", remote);
cmd.AddValue ("macClient", "Mac address of client (Optional).", macClient);
cmd.Parse (argc, argv);
Ipv4Address remoteIp (remote.c_str ());
Ipv4Address localIp ("192.168.43.1");
NS_ABORT_MSG_IF (localIp == "1.2.3.4", "You must change the local IP address before running this example");
Ipv4Mask localMask ("255.255.255.0");
//
// Since we are using a real piece of hardware we need to use the realtime
// simulator.
//
GlobalValue::Bind ("SimulatorImplementationType", StringValue ("ns3::RealtimeSimulatorImpl"));
//
// Since we are going to be talking to real-world machines, we need to enable
// calculation of checksums in our protocols.
//
GlobalValue::Bind ("ChecksumEnabled", BooleanValue (true));
//
// In such a simple topology, the use of the helper API can be a hindrance
// so we drop down into the low level API and do it manually.
//
// First we need a single node.
//
NS_LOG_INFO ("Create Node");
Ptr<Node> node = CreateObject<Node> ();
//
// Create an emu device, allocate a MAC address and point the device to the
// Linux device name. The device needs a transmit queueing discipline so
// create a droptail queue and give it to the device. Finally, "install"
// the device into the node.
//
// Do understand that the ns-3 allocated MAC address will be sent out over
// your network since the emu net device will spoof it. By default, this
// address will have an Organizationally Unique Identifier (OUI) of zero.
// The Internet Assigned Number Authority IANA
//
// http://www.iana.org/assignments/ethernet-numbers
//
// reports that this OUI is unassigned, and so should not conflict with
// real hardware on your net. It may raise all kinds of red flags in a
// real environment to have packets from a device with an obviously bogus
// OUI flying around. Be aware.
//
NS_LOG_INFO ("Create Device");
EmuFdNetDeviceHelper emu;
// set the dpdk emulation mode
char **ealArgv = new char*[20];
// arg[0] is program name (optional)
ealArgv[0] = new char[20];
strcpy (ealArgv[0], "");
// logical core usage
ealArgv[1] = new char[20];
strcpy (ealArgv[1], "-l");
// Use core 0 and 1
ealArgv[2] = new char[20];
strcpy (ealArgv[2], "0,1");
// Load library
ealArgv[3] = new char[20];
strcpy (ealArgv[3], "-d");
// Use e1000 driver library
ealArgv[4] = new char[20];
strcpy (ealArgv[4], "librte_pmd_e1000.so");
// Load library
ealArgv[5] = new char[20];
strcpy (ealArgv[5], "-d");
// Use mempool ring library
ealArgv[6] = new char[50];
strcpy (ealArgv[6], "librte_mempool_ring.so");
emu.SetDpdkMode (7, ealArgv);
emu.SetDeviceName (deviceName);
NetDeviceContainer devices = emu.Install (node);
Ptr<NetDevice> device = devices.Get (0);
device->SetAttribute ("Address", Mac48AddressValue (macClient.c_str ()));
//Ptr<Queue> queue = CreateObject<DropTailQueue> ();
//device->SetQueue (queue);
//node->AddDevice (device);
//
// Add a default internet stack to the node. This gets us the ns-3 versions
// of ARP, IPv4, ICMP, UDP and TCP.
//
NS_LOG_INFO ("Add Internet Stack");
InternetStackHelper internetStackHelper;
internetStackHelper.Install (node);
NS_LOG_INFO ("Create IPv4 Interface");
Ptr<Ipv4> ipv4 = node->GetObject<Ipv4> ();
uint32_t interface = ipv4->AddInterface (device);
Ipv4InterfaceAddress address = Ipv4InterfaceAddress (localIp, localMask);
ipv4->AddAddress (interface, address);
ipv4->SetMetric (interface, 1);
ipv4->SetUp (interface);
//
// When the ping application sends its ICMP packet, it will happily send it
// down the ns-3 protocol stack. We set the IP address of the destination
// to the address corresponding to example.com above. This address is off
// our local network so we have got to provide some kind of default route
// to ns-3 to be able to get that ICMP packet forwarded off of our network.
//
// You have got to provide an IP address of a real host that you can send
// real packets to and have them forwarded off of your local network. One
// thing you could do is a 'netstat -rn' command and find the IP address of
// the default gateway on your host and add it below, replacing the
// "1.2.3.4" string.
//
Ipv4Address gateway ("192.168.43.2");
NS_ABORT_MSG_IF (gateway == "1.2.3.4", "You must change the gateway IP address before running this example");
Ipv4StaticRoutingHelper ipv4RoutingHelper;
Ptr<Ipv4StaticRouting> staticRouting = ipv4RoutingHelper.GetStaticRouting (ipv4);
staticRouting->SetDefaultRoute (gateway, interface);
//
// Create the ping application. This application knows how to send
// ICMP echo requests. Setting up the packet sink manually is a bit
// of a hassle and since there is no law that says we cannot mix the
// helper API with the low level API, let's just use the helper.
//
NS_LOG_INFO ("Create V4Ping Appliation");
Ptr<V4Ping> app = CreateObject<V4Ping> ();
app->SetAttribute ("Remote", Ipv4AddressValue (remoteIp));
app->SetAttribute ("Verbose", BooleanValue (true) );
app->SetAttribute ("Interval", TimeValue (Seconds (samplingPeriod)));
node->AddApplication (app);
app->SetStartTime (Seconds (1.0));
app->SetStopTime (Seconds (21.0));
//
// Give the application a name. This makes life much easier when constructing
// config paths.
//
Names::Add ("app", app);
//
// Hook a trace to print something when the response comes back.
//
Config::Connect ("/Names/app/Rtt", MakeCallback (&PingRtt));
//
// Enable a promiscuous pcap trace to see what is coming and going on our device.
//
emu.EnablePcap ("dpdk-emu-ping", device, true);
//
// Now, do the actual emulation.
//
NS_LOG_INFO ("Run Emulation.");
Simulator::Stop (Seconds (22.0));
Simulator::Run ();
Simulator::Destroy ();
NS_LOG_INFO ("Done.");
}

6
src/fd-net-device/examples/wscript
View File

@@ -24,6 +24,12 @@ def build(bld):
obj = bld.create_ns3_program('fd-emu-onoff', ['fd-net-device', 'internet', 'applications'])
obj.source = 'fd-emu-onoff.cc'
if bld.env['ENABLE_DPDKNETDEV']:
obj = bld.create_ns3_program('fd-dpdk-emu-ping', ['fd-net-device', 'internet', 'internet-apps', 'applications'])
obj.source = 'fd-dpdk-emu-ping.cc'
obj = bld.create_ns3_program('fd-dpdk-emu-onoff', ['fd-net-device', 'internet', 'internet-apps', 'applications'])
obj.source = 'fd-dpdk-emu-onoff.cc'
if bld.env['ENABLE_TAP']:
obj = bld.create_ns3_program('fd-tap-ping', ['fd-net-device', 'internet', 'internet-apps'])
obj.source = 'fd-tap-ping.cc'