DHCP applications

.gitignore

@@ -35,3 +35,5 @@ TAGS
 
 build-dir/
 build/
+/.cproject
+/.project

src/internet-apps/doc/internet-apps.rst

@@ -14,16 +14,18 @@ The goal of this module is to hold all the Internet-specific applications,
 and most notably some very specific applications (e.g., ping) or daemons (e.g., radvd).  Other non-Internet-specific applications such as packet generators
 are contained in other modules.
 
-Model Description
-*****************
-
 The source code for the new module lives in the directory ``src/internet-apps``.
 
 Each application has its own goals, limitations and scope, which are briefly explained
 in the following.
 
+All the applications are extensively used in the top-level ``examples`` 
+directories. The users are encouraged to check the scripts therein to have a 
+clear overview of the various options and usage tricks.
+
+
 V4Ping
-======
+******
 
 This app mimics a "ping" (ICMP Echo) using IPv4. The application allows the 
 following attributes to be set:
@@ -36,7 +38,7 @@ following attributes to be set:
 Moreover, the user can access the measured rtt value (as a Traced Source).
 
 Ping6
-=====
+*****
 
 This app mimics a "ping" (ICMP Echo) using IPv6. The application allows the 
 following attributes to be set:
@@ -48,16 +50,77 @@ following attributes to be set:
 * Max number of packets to send
 
 Radvd
-=====
+*****
 
 This app mimics a "RADVD" daemon. I.e., the daemon responsible for IPv6 routers 
 advertisements. All the IPv6 routers should have a RADVD daemon installed.
 
 The configuration of the Radvd application mimics the one of the radvd Linux program.
 
-Examples and use
-****************
+DHCPv4
+******
+
+The |ns3| implementation of Dynamic Host Configuration Protocol (DHCP)
+follows the specifications of :rfc:`2131` and :rfc:`2132`.
+
+The source code for DHCP is located in ``src/internet-apps/model`` and consists of the 
+following 6 files:
+
+* dhcp-server.h,
+* dhcp-server.cc,
+* dhcp-client.h,
+* dhcp-client.cc,
+* dhcp-header.h and
+* dhcp-header.cc
+
+Helpers
+=======
+
+The following two files have been added to ``src/internet-apps/helper`` for DHCP: 
+
+* dhcp-helper.h and 
+* dhcp-helper.cc
+
+Tests
+=====
+The tests for DHCP can be found at ``src/internet-apps/test/dhcp-test.cc``
+
+Examples
+========
+The examples for DHCP can be found at ``src/internet-apps/examples/dhcp-example.cc``
+
+
+Scope and Limitations
+=====================
+
+The server should be provided with a network address, mask and a range of address
+for the pool. One client application can be installed on only one netdevice in a
+node, and can configure address for only that netdevice.
+
+The following five basic DHCP messages are supported: 
+
+* DHCP DISCOVER
+* DHCP OFFER
+* DHCP REQUEST
+* DHCP ACK
+* DHCP NACK
+
+Also, the following eight options of BootP are supported:
+
+* 1 (Mask)
+* 50 (Requested Address)
+* 51 (Address Lease Time)
+* 53 (DHCP message type)
+* 54 (DHCP server identifier)
+* 58 (Address renew time)
+* 59 (Address rebind time)
+* 255 (end)
+
+The client identifier option (61) can be implemented in near future.
+
+In the current implementation, a DHCP client can obtain IPv4 address dynamically 
+from the DHCP server, and can renew it within a lease time period.
+
+Multiple DHCP servers can be configured, but the implementation does not support
+the use of a DHCP Relay yet.
 
-All the applications are extensively used in the top-level ``examples`` 
-directories. The users are encouraged to check the scripts therein to have a 
-clear overview of the various options and usage tricks.

src/internet-apps/examples/dhcp-example.cc

@@ -0,0 +1,162 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2011 UPB
+ * Copyright (c) 2017 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: Radu Lupu <[email protected]>
+ *         Ankit Deepak <[email protected]>
+ *         Deepti Rajagopal <[email protected]>
+ *
+ */
+
+#include <fstream>
+#include "ns3/core-module.h"
+#include "ns3/network-module.h"
+#include "ns3/internet-apps-module.h"
+#include "ns3/csma-module.h"
+#include "ns3/internet-module.h"
+#include "ns3/point-to-point-module.h"
+#include "ns3/applications-module.h"
+
+using namespace ns3;
+
+NS_LOG_COMPONENT_DEFINE ("DhcpExample");
+
+int
+main (int argc, char *argv[])
+{
+  CommandLine cmd;
+
+  bool verbose = false;
+  bool tracing = false;
+  cmd.AddValue ("verbose", "turn on the logs", verbose);
+  cmd.AddValue ("tracing", "turn on the tracing", tracing);
+
+  cmd.Parse (argc, argv);
+
+  // GlobalValue::Bind ("ChecksumEnabled", BooleanValue (true));
+
+  if (verbose)
+    {
+      LogComponentEnable ("DhcpServer", LOG_LEVEL_ALL);
+      LogComponentEnable ("DhcpClient", LOG_LEVEL_ALL);
+      LogComponentEnable ("UdpEchoServerApplication", LOG_LEVEL_INFO);
+      LogComponentEnable ("UdpEchoClientApplication", LOG_LEVEL_INFO);
+    }
+
+  Time stopTime = Seconds (20);
+
+  NS_LOG_INFO ("Create nodes.");
+  NodeContainer nodes;
+  NodeContainer router;
+  nodes.Create (3);
+  router.Create (2);
+
+  NodeContainer net (nodes, router);
+
+  NS_LOG_INFO ("Create channels.");
+  CsmaHelper csma;
+  csma.SetChannelAttribute ("DataRate", StringValue ("5Mbps"));
+  csma.SetChannelAttribute ("Delay", StringValue ("2ms"));
+  csma.SetDeviceAttribute ("Mtu", UintegerValue (1500));
+  NetDeviceContainer devNet = csma.Install (net);
+
+  NodeContainer p2pNodes;
+  p2pNodes.Add (net.Get (4));
+  p2pNodes.Create (1);
+
+  PointToPointHelper pointToPoint;
+  pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
+  pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));
+
+  NetDeviceContainer p2pDevices;
+  p2pDevices = pointToPoint.Install (p2pNodes);
+
+  InternetStackHelper tcpip;
+  tcpip.Install (nodes);
+  tcpip.Install (router);
+  tcpip.Install (p2pNodes.Get (1));
+
+  Ipv4AddressHelper address;
+  address.SetBase ("172.30.1.0", "255.255.255.0");
+  Ipv4InterfaceContainer p2pInterfaces;
+  p2pInterfaces = address.Assign (p2pDevices);
+
+  // manually add a routing entry because we don't want to add a dynamic routing
+  Ipv4StaticRoutingHelper ipv4RoutingHelper;
+  Ptr<Ipv4> ipv4Ptr = p2pNodes.Get (1)->GetObject<Ipv4> ();
+  Ptr<Ipv4StaticRouting> staticRoutingA = ipv4RoutingHelper.GetStaticRouting (ipv4Ptr);
+  staticRoutingA->AddNetworkRouteTo (Ipv4Address ("172.30.0.0"), Ipv4Mask ("/24"),
+                                     Ipv4Address ("172.30.1.1"), 1);
+
+  NS_LOG_INFO ("Setup the IP addresses and create DHCP applications.");
+  DhcpHelper dhcpHelper;
+
+  // The router must have a fixed IP.
+  Ipv4InterfaceContainer fixedNodes = dhcpHelper.InstallFixedAddress (devNet.Get (4), Ipv4Address ("172.30.0.17"), Ipv4Mask ("/24"));
+  // Not really necessary, IP forwarding is enabled by default in IPv4.
+  fixedNodes.Get (0).first->SetAttribute ("IpForward", BooleanValue (true));
+
+  // DHCP server
+  ApplicationContainer dhcpServerApp = dhcpHelper.InstallDhcpServer (devNet.Get (3), Ipv4Address ("172.30.0.12"),
+                                                                     Ipv4Address ("172.30.0.0"), Ipv4Mask ("/24"),
+                                                                     Ipv4Address ("172.30.0.10"), Ipv4Address ("172.30.0.15"),
+                                                                     Ipv4Address ("172.30.0.17"));
+
+  // This is just to show how it can be done.
+  DynamicCast<DhcpServer> (dhcpServerApp.Get (0))->AddStaticDhcpEntry (devNet.Get (2)->GetAddress (), Ipv4Address ("172.30.0.14"));
+
+  dhcpServerApp.Start (Seconds (0.0));
+  dhcpServerApp.Stop (stopTime);
+
+  // DHCP clients
+  NetDeviceContainer dhcpClientNetDevs;
+  dhcpClientNetDevs.Add (devNet.Get (0));
+  dhcpClientNetDevs.Add (devNet.Get (1));
+  dhcpClientNetDevs.Add (devNet.Get (2));
+
+  ApplicationContainer dhcpClients = dhcpHelper.InstallDhcpClient (dhcpClientNetDevs);
+  dhcpClients.Start (Seconds (1.0));
+  dhcpClients.Stop (stopTime);
+
+  UdpEchoServerHelper echoServer (9);
+
+  ApplicationContainer serverApps = echoServer.Install (p2pNodes.Get (1));
+  serverApps.Start (Seconds (0.0));
+  serverApps.Stop (stopTime);
+
+  UdpEchoClientHelper echoClient (p2pInterfaces.GetAddress (1), 9);
+  echoClient.SetAttribute ("MaxPackets", UintegerValue (100));
+  echoClient.SetAttribute ("Interval", TimeValue (Seconds (1.0)));
+  echoClient.SetAttribute ("PacketSize", UintegerValue (1024));
+
+  ApplicationContainer clientApps = echoClient.Install (nodes.Get (1));
+  clientApps.Start (Seconds (10.0));
+  clientApps.Stop (stopTime);
+
+  Simulator::Stop (stopTime + Seconds (10.0));
+
+  if (tracing)
+    {
+      csma.EnablePcapAll ("dhcp-csma");
+      pointToPoint.EnablePcapAll ("dhcp-p2p");
+    }
+
+  NS_LOG_INFO ("Run Simulation.");
+  Simulator::Run ();
+  Simulator::Destroy ();
+  NS_LOG_INFO ("Done.");
+}

src/internet-apps/examples/wscript

@@ -0,0 +1,8 @@
+## -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
+
+def build(bld):
+    if not bld.env['ENABLE_EXAMPLES']:
+        return;
+
+    obj = bld.create_ns3_program('dhcp-example', ['internet', 'internet-apps', 'csma', 'point-to-point', 'applications'])
+    obj.source = 'dhcp-example.cc'