[Example] Finish Tunnel example

Author: Mingyumaz

examples/p4-basic-test-p2p.cc

@@ -14,6 +14,60 @@
 
 #include <iomanip>
 
+/**
+(p4dev-python-venv) p4@p4:~/workdir/ns3.35$ ./waf --run "p4-basic-test-p2p"
+/home/p4/workdir/ns3.35/bindings/python/wscript:321: SyntaxWarning: invalid escape sequence '\d'
+  m = re.match( "^castxml version (\d\.\d)(-)?(\w+)?", castxml_version_line)
+Waf: Entering directory `/home/p4/workdir/ns3.35/build'
+[1975/2937] Compiling contrib/p4sim/model/bridge-p4-net-device.cc
+[2884/2937] Linking build/lib/libns3.35-p4sim-debug.so
+[2885/2937] Linking build/lib/libns3.35-p4sim-test-debug.so
+[2886/2937] Linking build/contrib/p4sim/examples/ns3.35-p4sim-example-debug
+[2887/2937] Linking build/contrib/p4sim/examples/ns3.35-p4-basic-test-debug
+[2888/2937] Linking build/contrib/p4sim/examples/ns3.35-p4-basic-test-p2p-debug
+[2889/2937] Linking build/contrib/p4sim/examples/ns3.35-p4-custom-header-test-debug
+[2890/2937] Linking build/contrib/p4sim/examples/ns3.35-p4-basic-example-debug
+[2891/2937] Linking build/contrib/p4sim/examples/ns3.35-p4-basic-tunnel-example-debug
+[2892/2937] Linking build/contrib/p4sim/examples/ns3.35-p4-p2p-custom-header-test-debug
+[2893/2937] Linking build/contrib/p4sim/examples/ns3.35-p4-custom-test-debug
+[2894/2937] Linking build/scratch/subdir/subdir
+[2895/2937] Linking build/scratch/simple-on-off
+[2896/2937] Linking build/scratch/scratch-simulator
+[2897/2937] Linking build/utils/ns3.35-test-runner-debug
+Waf: Leaving directory `/home/p4/workdir/ns3.35/build'
+Build commands will be stored in build/compile_commands.json
+'build' finished successfully (10.030s)
+*** Reading topology from file: /home/p4/workdir/ns3.35/contrib/p4sim/test/custom_header/topo.txt with format: P2PTopo
+*** Host number: 2, Switch number: 2
+*** Link from host 2 to  switch0 with data rate  and delay 
+*** Link from  switch 0 to  switch 1 with data rate  and delay 
+*** Link from host 3 to  switch1 with data rate  and delay 
+host 0: connect with switch 0 port 0
+host 1: connect with switch 1 port 1
+switch 0 connect with: h0 s1_0 
+switch 1 connect with: s0_1 h1 
+Node IP and MAC addresses:
+Node 0: IP = 10.1.1.1, MAC = 00:00:00:00:00:01
+Node 0: IP = 0x0a010101, MAC = 0x000000000001
+Node 1: IP = 10.1.1.2, MAC = 00:00:00:00:00:05
+Node 1: IP = 0x0a010102, MAC = 0x000000000005
+Host 0 NetDevice is CustomP2PNetDevice, Setting for the Tunnel Header!
+Host 1 NetDevice is CustomP2PNetDevice, Setting for the Tunnel Header!
+*** P4Simulator mode
+*** Installing P4 bridge [ 0 ] device with configuration: 
+P4JsonPath = /home/p4/workdir/ns3.35/contrib/p4sim/test/custom_header/custom_header.json, 
+FlowTablePath = /home/p4/workdir/ns3.35/contrib/p4sim/test/custom_header/flowtable_0.txt, 
+ViewFlowTablePath = /home/p4/workdir/ns3.35/contrib/p4sim/test/custom_header/flowtable_0.txt
+*** Installing P4 bridge [ 1 ] device with configuration: 
+P4JsonPath = /home/p4/workdir/ns3.35/contrib/p4sim/test/custom_header/custom_header.json, 
+FlowTablePath = /home/p4/workdir/ns3.35/contrib/p4sim/test/custom_header/flowtable_1.txt, 
+ViewFlowTablePath = /home/p4/workdir/ns3.35/contrib/p4sim/test/custom_header/flowtable_1.txt
+Running simulation...
+Simulate Running time: 99ms
+Total Running time: 10299ms
+Run successfully!
+ */
+
 using namespace ns3;
 
 NS_LOG_COMPONENT_DEFINE ("P4BasicTestP2P");
@@ -73,11 +127,11 @@ main (int argc, char *argv[])
 
   // ============================ parameters ============================
 
-  ns3::PacketMetadata::Enable (); // 开启数据包元数据追踪
+  // ns3::PacketMetadata::Enable (); // 开启数据包元数据追踪
 
   LogComponentEnable ("P4BasicTestP2P", LOG_LEVEL_INFO);
-  LogComponentEnable ("CustomP2PNetDevice", LOG_LEVEL_DEBUG);
-  LogComponentEnable ("BridgeP4NetDevice", LOG_LEVEL_DEBUG);
+  // LogComponentEnable ("CustomP2PNetDevice", LOG_LEVEL_DEBUG);
+  // LogComponentEnable ("BridgeP4NetDevice", LOG_LEVEL_DEBUG);
 
   // ============================ parameters ============================
 

examples/p4-basic-tunnel-example.cc

@@ -1,13 +1,14 @@
 #include "ns3/core-module.h"
 #include "ns3/network-module.h"
 #include "ns3/applications-module.h"
-#include "ns3/csma-helper.h"
+#include "ns3/p4-p2p-helper.h"
 #include "ns3/internet-module.h"
 #include "ns3/bridge-helper.h"
 #include "ns3/p4-helper.h"
 #include "ns3/global.h"
 
 #include "ns3/custom-header.h"
+#include "ns3/custom-p2p-net-device.h"
 #include "ns3/format-utils.h"
 #include "ns3/p4-topology-reader-helper.h"
 
@@ -74,7 +75,7 @@ main (int argc, char *argv[])
   // ============================ parameters ============================
 
   // Simulation parameters
-  uint16_t pktSize = 512; //in Bytes. 1458 to prevent fragments, default 512
+  uint16_t pktSize = 1000; //in Bytes. 1458 to prevent fragments, default 512
 
   // h1 -> h3 with 2.0Mbps, h2 -> h4 with 1.0Mbps
   std::string appDataRate[] = {"2.0Mbps", "1.0Mbps"};
@@ -127,9 +128,11 @@ main (int argc, char *argv[])
   NS_LOG_INFO ("*** Host number: " << hostNum << ", Switch number: " << switchNum);
 
   // set default network link parameter
-  CsmaHelper csma;
-  csma.SetChannelAttribute ("DataRate", StringValue ("10Mbps")); //@todo
-  csma.SetChannelAttribute ("Delay", TimeValue (MilliSeconds (0.01)));
+  // CsmaHelper csma;
+  // csma.SetChannelAttribute ("DataRate", StringValue ("10Mbps")); //@todo
+  // csma.SetChannelAttribute ("Delay", TimeValue (MilliSeconds (0.01)));
+  P4PointToPointHelper p4p2phelper;
+  p4p2phelper.SetChannelAttribute ("Delay", TimeValue (MilliSeconds (0.01)));
 
   //  ============================  init network link info ============================
   P4TopologyReader::ConstLinksIterator_t iter;
@@ -139,13 +142,13 @@ main (int argc, char *argv[])
   std::string dataRate, delay;
   for (iter = topoReader->LinksBegin (); iter != topoReader->LinksEnd (); iter++)
     {
-      if (iter->GetAttributeFailSafe ("DataRate", dataRate))
-        csma.SetChannelAttribute ("DataRate", StringValue (dataRate));
-      if (iter->GetAttributeFailSafe ("Delay", delay))
-        csma.SetChannelAttribute ("Delay", StringValue (delay));
+      // if (iter->GetAttributeFailSafe ("DataRate", dataRate))
+      //   csma.SetChannelAttribute ("DataRate", StringValue (dataRate));
+      // if (iter->GetAttributeFailSafe ("Delay", delay))
+      //   csma.SetChannelAttribute ("Delay", StringValue (delay));
 
       NetDeviceContainer link =
-          csma.Install (NodeContainer (iter->GetFromNode (), iter->GetToNode ()));
+          p4p2phelper.Install (NodeContainer (iter->GetFromNode (), iter->GetToNode ()));
       fromIndex = iter->GetFromIndex ();
       toIndex = iter->GetToIndex ();
       if (iter->GetFromType () == 's' && iter->GetToType () == 's')
@@ -319,39 +322,35 @@ main (int argc, char *argv[])
         }
     }
 
-  //// Custom defined header for P4 switch (for the p4 code)
-  //
-  // header myTunnel_t
-  // {
-  //   bit<16> proto_id;
-  //   bit<16> dst_id;
-  // }
-  //
-  // struct headers
-  // {
-  //   ethernet_t ethernet;
-  //   arp_t arp;
-  //   myTunnel_t myTunnel;
-  //   ipv4_t ipv4;
-  // }
-
-  // Step 1: Create an instance of CustomHeader for myTunnel_t
+  // ============================ add custom header for the p4 switch ============================
+
   CustomHeader myTunnelHeader;
-  myTunnelHeader.SetLayer (LAYER_3); // Network Layer
+  myTunnelHeader.SetLayer (HeaderLayer::LAYER_3); // Network Layer
   myTunnelHeader.SetOperator (ADD_BEFORE); // add before the ipv4 header
 
-  // Step 2: Define the fields for myTunnel_t
-  myTunnelHeader.AddField ("proto_id", 16); // Protocol ID: 16 bits
-  myTunnelHeader.AddField ("dst_id", 16); // Destination ID: 16 bits
-
-  // Step 3: Set values for the fields
   myTunnelHeader.SetField ("proto_id", 0x0800); // Example: IPv4 protocol
-  myTunnelHeader.SetField ("dst_id", 42); // Example: Destination ID
+  myTunnelHeader.SetField ("dst_id", 0x22); // Example: Destination ID
+
+  // Set for the NetDevice
+  for (unsigned int i = 0; i < hostNum; i++)
+    {
+      Ptr<NetDevice> device = hostNodes[i].hostDevice.Get (0);
+      if (device->GetObject<CustomP2PNetDevice> ())
+        {
+          NS_LOG_DEBUG (
+              "Host " << i << " NetDevice is CustomP2PNetDevice, Setting for the Tunnel Header!");
+          Ptr<CustomP2PNetDevice> customDevice = DynamicCast<CustomP2PNetDevice> (device);
+          customDevice->SetWithCustomHeader (true);
+          customDevice->SetCustomHeader (myTunnelHeader);
+        }
+    }
+
+  // ============================ add application to the hosts ============================
 
-  // == First == send link h0 -----> h1
+  // TUNNEL stream == First == send link h0 -----> h1
   unsigned int serverI = 1;
   unsigned int clientI = 0;
-  uint16_t servPort = 9093; // setting for port
+  uint16_t servPort = 12000; // setting for port
 
   Ptr<Node> node = terminals.Get (serverI);
   Ptr<Ipv4> ipv4_adder = node->GetObject<Ipv4> ();
@@ -370,14 +369,40 @@ main (int argc, char *argv[])
   onOff1.SetAttribute ("DataRate", StringValue (appDataRate[0]));
   onOff1.SetAttribute ("OnTime", StringValue ("ns3::ConstantRandomVariable[Constant=1]"));
   onOff1.SetAttribute ("OffTime", StringValue ("ns3::ConstantRandomVariable[Constant=0]"));
-  onOff1.SetAttribute ("MaxBytes", UintegerValue (5000));
+  onOff1.SetAttribute ("MaxBytes", UintegerValue (3000));
 
   ApplicationContainer app1 = onOff1.Install (terminals.Get (clientI));
   app1.Start (Seconds (client_start_time));
   app1.Stop (Seconds (client_stop_time));
 
+  // Normal Stream == Second == send link h0 -----> h1
+  servPort = 1200; // change the application port
+
+  // node = terminals.Get (serverI);
+  // ipv4_adder = node->GetObject<Ipv4> ();
+  // serverAddr1 =
+  //     ipv4_adder->GetAddress (1, 0)
+  //         .GetLocal (); // Interface index 1 corresponds to the first assigned IP
+  InetSocketAddress dst2 = InetSocketAddress (serverAddr1, servPort);
+  PacketSinkHelper sink2 = PacketSinkHelper ("ns3::UdpSocketFactory", dst2);
+  ApplicationContainer sinkApp2 = sink2.Install (terminals.Get (serverI));
+
+  sinkApp2.Start (Seconds (sink_start_time));
+  sinkApp2.Stop (Seconds (sink_stop_time));
+
+  OnOffHelper onOff2 ("ns3::UdpSocketFactory", dst2);
+  onOff2.SetAttribute ("PacketSize", UintegerValue (pktSize));
+  onOff2.SetAttribute ("DataRate", StringValue (appDataRate[0]));
+  onOff2.SetAttribute ("OnTime", StringValue ("ns3::ConstantRandomVariable[Constant=1]"));
+  onOff2.SetAttribute ("OffTime", StringValue ("ns3::ConstantRandomVariable[Constant=0]"));
+  onOff2.SetAttribute ("MaxBytes", UintegerValue (5000));
+
+  ApplicationContainer app2 = onOff2.Install (terminals.Get (clientI));
+  app2.Start (Seconds (client_start_time));
+  app2.Stop (Seconds (client_stop_time));
+
   // Enable pcap tracing
-  csma.EnablePcapAll ("p4-basic-tunnel-example");
+  p4p2phelper.EnablePcapAll ("p4-basic-tunnel-example");
 
   // Run simulation
   NS_LOG_INFO ("Running simulation...");

examples/p4-custom-test.cc

@@ -75,7 +75,7 @@ main (int argc, char *argv[])
 
   // ============================ parameters ============================
 
-  ns3::PacketMetadata::Enable (); // 开启数据包元数据追踪
+  // ns3::PacketMetadata::Enable (); // 开启数据包元数据追踪
 
   // Simulation parameters
   uint16_t pktSize = 1000; //in Bytes. 1458 to prevent fragments, default 512

helper/global.h

@@ -63,14 +63,20 @@ class P4GlobalVar : public Object
   static std::string g_flowTablePath;
   static std::string g_viewFlowTablePath;
   static std::string g_p4JsonPath;
+
+  // Protocol number used to identify the custom P4 header in nested packet parsing.
+  // The previous header's protocol field indicates that the next is a custom header
   static constexpr uint64_t g_p4Protocol = 0x12;
 
-  // Here if dst_port of the udp/tcp header in [g_portRangeMin, g_portRangeMax],
-  // the packet will add the custom header.
+  // Port range used to determine whether a packet should include the custom header.
+  // In NS-3, the same port may handle different types of packets.
+  // If the destination port in the UDP/TCP header falls within [g_portRangeMin, g_portRangeMax],
+  // the packet will be assigned a custom header.
   static constexpr uint64_t g_portRangeMin = 10000;
   static constexpr uint64_t g_portRangeMax = 20000;
 
-  // Custom header fields
+  // Defines the structure and field lengths of the custom header.
+  // Users should modify this based on simulation requirements.
   static constexpr std::array<std::pair<const char *, uint32_t>, 2> g_templateHeaderFields = {
       {{"proto_id", 16}, {"dst_id", 16}}};