ns3脚本first.cc的分析

转载博文：https://blog.csdn.net/tttabcgy/article/details/77295201

3.2 分析例子程序first.cc的源代码

进入ns-3.15/examples/tutorial目录。你会发现一个叫first.cc的文件。这一个脚本会在两个节点间创建一个简单的点到点的连接，并且在这两个节点之间传送一个数据包。为方便后续分许，先将first.cc的源代码粘贴如下：

#include "ns3/core-module.h"

#include "ns3/network-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 ("FirstScriptExample");

 

intmain (int argc, char *argv[])

{

LogComponentEnable ("UdpEchoClientApplication", LOG_LEVEL_INFO);

LogComponentEnable ("UdpEchoServerApplication", LOG_LEVEL_INFO);

 

NodeContainer nodes;

nodes.Create (2);

 

PointToPointHelper pointToPoint;

pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));

pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));

 

NetDeviceContainer devices;

devices = pointToPoint.Install (nodes);

 

InternetStackHelper stack;

stack.Install (nodes);

 

Ipv4AddressHelper address;

address.SetBase ("10.1.1.0", "255.255.255.0");

 

Ipv4InterfaceContainer interfaces = address.Assign (devices);

 

UdpEchoServerHelper echoServer (9);

 

ApplicationContainer serverApps = echoServer.Install (nodes.Get (1));

serverApps.Start (Seconds (1.0));

serverApps.Stop (Seconds (10.0));

 

UdpEchoClientHelper echoClient (interfaces.GetAddress (1), 9);

echoClient.SetAttribute ("MaxPackets", UintegerValue (1));

echoClient.SetAttribute ("Interval", TimeValue (Seconds (1.0)));

echoClient.SetAttribute ("PacketSize", UintegerValue (1024));

 

ApplicationContainer clientApps = echoClient.Install (nodes.Get (0));

clientApps.Start (Seconds (2.0));

clientApps.Stop (Seconds (10.0));

 

Simulator::Run ();

Simulator::Destroy ();

return 0;

}

3.2.1 模块包含

代码一般是以一系列的include声明开始的：

#include "ns3/core-module.h"

#include "ns3/simulator-module.h"

#include "ns3/node-module.h"

#include "ns3/helper-module.h"

为了帮助高层的脚本用户处理大量的系统中的include文件，我们把所有的包含文件，根据模块功能，进行了大致的分类。我们提供了一个单独的include文件，这个文件会递归加载所有会在每个模块中会被使用的include文件。NS3提供了按大致功能分类的一组include文件，在使用时只需选择包含这几个包含文件(include文件)，而不用考虑复杂的依赖关系，省去在寻找所需要的头文件上花费的不必要的时间。这不是最有效地方法但很明显让编写脚本文件容易多了。

在编译的过程中，每一个ns-3的include文件被放在build目录下一个叫ns3的目录中，这样做可以避免include文件名的冲突。ns3/core-module.h与src/core目录下的模块相对应。查看ns3目录会发现大量的头文件。当你编译时，Waf会根据配置把在ns3目录下的公共的头文件放到build/debug 或者build/optimized目录下。Waf也会自动产生一个模块include文件来加载所有的公共头文件。

当然，如果遵循着这个手册走的话，你可能已经使用过如下命令：

./waf -d debug --enable-examples --enable-tests configure

来配置工程以完成调试工作。你可能同样使用了如下命令：

./waf

来编译ns-3。现在如果你进入../../build/debug/ns3 目录的话你会发现本节开头提到的四个头文件。仔细看一下这些文件的内容，会发现它们包含了相关模块中的所有的include文件。

3.2.2 命名空间

在first.cc脚本的下一行是namespace的声明。

using namespace ns3;

NS3工程是在一个叫做ns3的C++ 命名空间中实现的。这把所有与ns3相关的声明，集中在一个与全局命名空间相区别的命名空间中。我们希望这样会给ns3与其他代码的集成带来好处。C++用“using”语句用来把ns-3 namespace引入到当前的（全局的）作用域中。这个声明就是说，你不用为了使用ns-3的代码而必须在所有的ns-3代码前打上ns3:: 作用域操作符。如果对命名空间并不熟悉，可以查阅任何的C++手册并比较ns3命名空间和标准”std”命名空间的使用。

3.2.3 日志

下一句脚本如下：

NS_LOG_COMPONENT_DEFINE ("FirstScriptExample");

这一行声明了一个叫FirstScriptExample的日志组件，通过引用FirstScriptExample这个名字的操作，可以实现打开或者关闭控制台日志的输出。

3.2.4 Main函数

下面的脚本是：

int

main (int argc, char *argv[])

{

这就是你的脚本程序的主函数的声明。正如任何其它C++程序一样，你需要定义一个会被第一个执行的主函数。你的ns-3脚本没有什么特别的，就和一个普通的C++程序一样。

再接下来两行脚本是用来使两个日志组件生效的。它们被内建在Echo Client 和Echo Server 应用中：

LogComponentEnable("UdpEchoClientApplication", LOG_LEVEL_INFO);

LogComponentEnable("UdpEchoServerApplication", LOG_LEVEL_INFO);

3.2.5 使用基本对象模型搭建仿真拓扑

3.2.5.1使用NodeContainer类

在first.cc脚本中的下面两行将会创建ns-3节点对象。

NodeContainer nodes;

nodes.Create (2);

上面的第一行只是声明了一个名为”nodes”的NodeContainer。第二行调用了nodes对象的Create()方法创建了两个节点。

3.2.5.2使用PointToPointHelper类

接下来，我们将会用到被称为拓扑辅助工具的helper类。这些helper类里面封装了低级的方法，有助于我们高效的建立仿真拓扑。

回忆一下我们的两个关键抽象概念：网络设备、信道。在真实的世界中，这些东西大致相当于网卡和网线。需要说明的是这两样东西紧密的联系在一起而不能够把它们交互地使用（比如以太网设备和无线信道就不能一起使用）。在这个脚本中使用了PointToPointHelper来配置和连接网络设备PointToPointNetDevice和信道PointToPointChannel对象。

在脚本中下面的三句话是：

PointToPointHelper pointToPoint;

pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));

pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));

其中第一行，

PointToPointHelper pointToPoint;

在栈中初始化了一个PointToPointHelper的对象pointToPoint。而紧接着的下一行，

pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));

从上层的角度告诉PointToPointHelper对象当创建一个PointToPointNetDevice对象时使用“5Mbps"来作为数据速率。

从细节方面讲，字符串“DataRate”与PointToPointNetDevice的一个属性相对应。如果查看ns3::PointToPointNetDevice 类，并阅读GetTypeId 方法的文档，你会发现设备定义了一系列属性，在这些属性中就有“DataRate”。大部分用户可见的ns-3对象都有类似的属性列表。正如你在下面的部分会看到的一样，我们使用了这个机制以方便地配置仿真器，而不用重新对源代码进行编译。

与PointToPointNetDevice上的“DataRate”类似，PointToPointChannel也有一个Delay属性：

pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));

告诉PointToPointHelper使用"2ms"（2毫秒）作为每一个被创建的点到点信道传输延时值。

3.2.5.3使用NetDeviceContainer类

现在我们有一个包含两个节点的NodeContainer对象。我们有一个准备在两个节点之间创建PointToPointNetDevices和wirePointToPointChannel对象的PointToPointHelper对象。正如我们使用NodeContainer对象来为我们创建节点，我们会让pointToPointHelper来做关于创建，配置和安装设备的工作。

我们使用一个NetDeviceContainer对象来存放需要所有被创建的NetDevice对象，就像我们使用一个NodeContainer对象来存放我们所创建节点。下面两行代码：

NetDeviceContainer devices;

devices = pointToPoint.Install (nodes);

会完成设备和信道的配置。第一行声明了上面提到的设备容器，第二行完成了主要工作。PointToPointHelper的Install()方法以一个NodeContainer对象作为一个参数。在Install()方法内，一个NetDeviceContainer被创建了。对于在NodeContainer 对象中的每一个节点（对于一个点到点链路必须明确有两个节点)，都将有一个PointToPointNetDevice被创建和保存在设备容器内，有一个PointToPointChannel对象被创建，两个PointToPointNetDevices与之连接。当PointToPointHelper对象创建时，那些在helper中被预先设置的属性被用来初始化对象对应的属性值。

当调用了pointToPoint.Install(nodes)后，我们会有两个节点，每一个节点安装了点到点网络设备，在它们之间是一个点到点信道。两个设备会被配置在一个有2ms传输延时的信道上以5Mbps的速率传输数据。

3.2.5.4使用InternetStackHelper类

我们现在已经配置了节点和设备，但是我们还没有在节点上安装任何协议栈。下面两行代码完成这个任务：

InternetStackHelper stack;

stack.Install (nodes);

类InternetStackHelper 是一个辅助安装网络协议栈的helper类。其中Install()方法以NodeContainer 对象作为参数，当它被执行后，它会为节点容器中的每一个节点安装一个网络协议栈（TCP,UDP,IP等）。

3.2.5.5使用Ipv4AddressHelper类

下面我们需要为节点上的设备设置IP地址。我们也提供了一个helper类来管理IP地址的分配。当执行实际的地址分配时唯一用户可见的API是设置IP地址和子网掩码。

在我们的范例脚本文件first.cc的下两行代码

Ipv4AddressHelper address;

address.SetBase ("10.1.1.0", "255.255.255.0");

声明了一个helper对象，并且告诉它应该开始从10.1.1.0开始以子网掩码为255.255.255.0分配地址。地址分配默认是从1开始并单调的增长，所以在这个基础上第一个分配的地址会是10.1.1.1，紧跟着是10.1.1.2等等。底层NS3系统事实上会记住所有分配的IP地址，如果你无意导致了相同IP地址的产生，这将是一个致命的错误（顺便说一下，这是个很难调试正确的错误）。

下面一行代码，

Ipv4InterfaceContainer interfaces = address.Assign (devices);

完成了真正的地址配置。在NS3中我们使用 Ipv4Interface对象将一个IP地址同一个网络设备关联起来。正如我们有时候需要一个网络设备列表一样，我们有时候需要一个 Ipv4Interface对象的列表。Ipv4InterfaceContainer提供了这样的功能。

现在我们有了一个安装了协议栈，配置了IP地址的点到点的网络。剩下的所要做的事情是运用它来产生数据通信。

3.2.5.6 Applications类

NS3系统的另一个核心抽象是Application类。在这个脚本中我们用两个特定的Application类：UdpEchoServerApplication和UdpEchoClientApplication。正如我们先前声明过的一样，我们使用helper对象来帮助配置和管理潜在的对象。在这里，我们用UdpEchoServerHelper 和UdpEchoClientHelper对象来使我们的工作更加容易点。

首先来看UdpEchoServerHelper类：

下面的代码用来在我们之前创建的节点上设置一个UDP 回显服务应用。

UdpEchoServerHelper echoServer (9);

ApplicationContainer serverApps = echoServer.Install (nodes.Get (1));

serverApps.Start (Seconds (1.0));

serverApps.Stop (Seconds (10.0));

上面一片代码中的第一行声明了UdpEchoServerHelper。像往常一样，这个并非应用本身，这是一个用来帮助创建真正应用的helper对象。我们约定在helper类的对象中放置必需的属性。本例中，除非我们告知helper对象服务器和客户端所共知的一个端口号，否则这个helper对象是不会起任何作用的。

同其它helper对象类似，UdpEchoServerHelper对象有一个Install()方法。实际上是这个方法的执行，才初始化回显服务器的应用，并将应用连接到一个节点上去。有趣的是，install()方法把NodeContainter参数，正如我们看到的其他安装方法一样。这里有一个C++隐式转换，此转换以nodes.Get(1)的结果作为输入，并把它作为一个NodeContainer的构造函数的参数，最终这个新构造的NodeContainer被送入Install方法中去。

我们现在会看到echoServer.Install将会在管理节点的NodeContainer容器索引号为1的机节点上安装一个UdpEchoServerApplication。安装会返回一个容器，这个容器中包含了指向所有被helper对象创建的应用指针。

应用程序对象需要一个时间参数来“开始”产生数据通信并且可能在一个可选的时间点“停止”。我们提供了开始和停止的两个参数。这些时间点是用ApplicationContainer的方法Start和Stop来设置的。这些方法以”Time”对象为参数。本例中，我们传递了double类型对象1.0到Seconds的一个方法，通过seconds()方法，把它转换到ns-3的Time对象。需要注意的是，这里的转换规则是模型的作者所控制的，并且C++也有它自己的标准，所以你不能总是假定参数会按照你的意愿顺利地转换。下面两行，

serverApps.Start (Seconds (1.0));

serverApps.Stop (Seconds (10.0));

会使echo服务应用在1s时开始（生效）并在10s时停止（失效）。既然我们已经声明了一个模拟事件（就是应用的停止事件）在10s时被执行，模拟至少会持续10s。

然后再来看UdpEchoClientHelper类：

echo客户端应用的设置与回显服务器端类似。也有一个UdpEchoClientHelper来管理UdpEchoClientApplication。

UdpEchoClientHelper echoClient (interfaces.GetAddress (1), 9);

echoClient.SetAttribute ("MaxPackets", UintegerValue (1));

echoClient.SetAttribute ("Interval", TimeValue (Seconds (1.)));

echoClient.SetAttribute ("PacketSize", UintegerValue (1024));

ApplicationContainer clientApps = echoClient.Install (nodes.Get (0));

clientApps.Start (Seconds (2.0));

clientApps.Stop (Seconds (10.0));

然而，对于echo客户端，我们需要设置五个不同的属性。首先两个属性是在UdpEchoClientHelper的构建过程中被设置的。按照UdpEchoClientHelper构造函数的格式，我们传递了”RemoteAdress”和”RemotePort”属性，来实例化对象。

在上面的第一行代码中，我们创建了一个UdpEchoClientHelper的对象，并告诉它设置客户端的远端地址为服务器节点的IP地址。我们同样告诉它准备发送数据包到端口9。

“MaxPackets”属性告诉客户端我们所允许它在模拟期间所能发送的最大数据包个数。

“Interval”属性告诉客户端在两个数据包之间要等待多长时间。

“PacketSize”属性告诉客户端它的数据包应该承载多少数据。本例中，我们让客户端发送一个1024字节的数据包。

正如echo服务端一样，我们告诉echo客户端何时来开始和停止，这里我们使客户端在模拟器中时间为2s的时候开始(即服务端生效1s后才开始)。

3.2.5.7Simulator类

下面我们所需要做的就是运行模拟器，这是用全局函数Simulator::Run.来做到的：

Simulator::Run ();

当我们调用了如下方法时：

serverApps.Start (Seconds (1.0));

serverApps.Stop (Seconds (10.0));

...

clientApps.Start (Seconds (2.0));

clientApps.Stop (Seconds (10.0));

实际上我们是在模拟器中1.0s，2.0s，和10.0s时预设了时间的发生。当Simulator::Run被调用时，系统会开始遍历预设事件的列表并执行。首先它会在1.0s时运行事件，这个事件会使echo服务端应用生效（这个事件会预设更多的其他事件）。接下来仿真器会运行在t=2.0s时的事件，即让echo客户端应用开始。同样的，这个事件可能会预定更多的其他事件。在echo客户端应用中的开始事件的执行会通过给服务端传送一个数据包来开始仿真的数据传送阶段。

发送一个数据包给服务端会引发一系列更多的事件。这些事件会被预设在此事件之后，并根据我们已经在脚本中设定的时间参数来执行数据包的应答。

其实，我们只发送了一个数据包（回忆一MaxPackets属性被设置为1），在此之后，那个被单独的客户端应答请求所引发的连锁反应会停止，并且模拟器会进入空闲状态。当这发生时，生下来的事件就是服务端和客户端的Stop事件。当这些事件被执行后，就没有将来的事件来执行了，函数Simulator::Run会返回。整个模拟过程就结束了。

下面剩下的事情就是清理了。这个通过调用全局函数Simulator::Destroy来完成。当该方法被执行后，模拟器中所有创建的对象将被销毁。你自己并不需要追踪任何对象，你所需要做的仅仅是调用Simulator::Destroy并且退出。ns-3系统会帮你料理这些繁杂的任务。在first.cc脚本中对应的代码如下：

Simulator::Destroy ();

return 0;

}