2022-05-17

字数统计: 3.5k字 | 阅读时长: 15分

ns3使用-1

ns-3基本使用：

./waf --run hello-simulator
#保存std::cout至output文件
./waf --run script_name 1 > output
#保存NS_LOG输出至output文件
./waf --run script_name 2 > output
#修改配置选项，详细使用见下表
./waf configure
#编译和运行脚本
./waf

选项名	含义
`--enable-examples`	编译时包括`ns/src/<模块>/examples`，`ns/examples`下面所有目录下的examples脚本
`--enable-tests`	编译时包括`ns/src/<模块>/test`目录下的examples脚本
`--build-profile`	修改编译模式：`debug`或者`optimized`

源代码的目录结构：

子目录名	含义
bindings	python绑定
doc	各个模块的文档
examples	示例脚本
helper	助手类源代码
model	模块源代码
test	测试用例源代码

用户若运行ns-3自带的示例脚本，需要配置添加--enable-examples选项，这样在./waf编译时会在build目录下生成一个同名可执行文件，这时就不用指定脚本源文件路径了。

用户添加新脚本，应该放在ns3/scratch目录下。

ns-3入门：first.cc脚本解析

参考：NS3入门：第一个程序first.cc_一只揪°的博客-CSDN博客

#include "ns3/core-module.h" //定义的ns-3的模拟事件，事件调度等
#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; //将ns3项目和非ns3项目隔离，便于与其他项目整合。

NS_LOG_COMPONENT_DEFINE ("FirstScriptExample");//NS_LOG是ns中的一系列宏定义，用于输出错误信息。

int
main (int argc, char *argv[]) //主函数
{
  CommandLine cmd;
  cmd.Parse (argc, argv); //读取命令行参数
  
  Time::SetResolution (Time::NS); //最小时间单位：ns
  //打印指定Log组件
  LogComponentEnable ("UdpEchoClientApplication", LOG_LEVEL_INFO);
  LogComponentEnable ("UdpEchoServerApplication", LOG_LEVEL_INFO);
  //以上步骤都是可以省略的
  NodeContainer nodes; //可以将node理解为将要添加功能的计算机
  nodes.Create (2);

  PointToPointHelper pointToPoint;
  //配置P2P信道属性      https://blog.csdn.net/loongkingwhat/article/details/53455691
  pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
  pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));
 
  //配置NetDevice，负责链路层协议
  NetDeviceContainer devices;
  devices = pointToPoint.Install (nodes);
  
  //安装TCP/IP协议族
  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); //创建服务器端应用echoServer,接收9号端口的数据
  //在节点1安装echoserver服务
  ApplicationContainer serverApps = echoServer.Install (nodes.Get (1)); 
  serverApps.Start (Seconds (1.0));//echoServer启动1s后开始监听9号端口的数据
  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 (); //按照时间顺序模拟所有的时间，如1s开启服务端程序。
  Simulator::Destroy ();
  return 0;  //告诉操作系统执行成功
}

Wifi-无线网络：third脚本

(2条消息) NS-3实例分析——third.cc_xxyxiaxinyan的博客-CSDN博客_ns3实例

//该脚本的第一行是 emacs 模式行。这告诉 emacs 我们在源代码中使用的格式约定（编码风格）
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

#include "ns3/core-module.h"
#include "ns3/point-to-point-module.h"
#include "ns3/network-module.h"
#include "ns3/applications-module.h"
#include "ns3/mobility-module.h" //移动模块
#include "ns3/csma-module.h" //CSMA模块
#include "ns3/internet-module.h"
#include "ns3/yans-wifi-helper.h"
#include "ns3/ssid.h"

// Default Network Topology
//
//   Wifi 10.1.3.0
//                 AP
//  *    *    *    *
//  |    |    |    |    10.1.1.0
// n5   n6   n7   n0 -------------- n1   n2   n3   n4
//                   point-to-point  |    |    |    |
//                                   ================
//                                     LAN 10.1.2.0

using namespace ns3;

NS_LOG_COMPONENT_DEFINE ("ThirdScriptExample");

int 
main (int argc, char *argv[])
{
  bool verbose = true;
  uint32_t nCsma = 3;
  uint32_t nWifi = 3;
  bool tracing = false;//如果要开启日志追踪（生成.pcap文件），tracing=true;
  //命令行参数设置，nWifi 参数控制着脚本中的无线节点数量，也可以造waf命令中设置：
  // sudo ./waf --run "third --nWifi =18"
  CommandLine cmd;
  cmd.AddValue ("nCsma", "Number of \"extra\" CSMA nodes/devices", nCsma);
  cmd.AddValue ("nWifi", "Number of wifi STA devices", nWifi);
  cmd.AddValue ("verbose", "Tell echo applications to log if true", verbose);
  cmd.AddValue ("tracing", "Enable pcap tracing", tracing);

  cmd.Parse (argc,argv);

  // The underlying restriction of 18 is due to the grid position
  // allocator's configuration; the grid layout will exceed the
  // bounding box if more than 18 nodes are provided.
  if (nWifi > 18)
    {
      std::cout << "nWifi should be 18 or less; otherwise grid layout exceeds the bounding box" << std::endl;
      return 1;
    }

  if (verbose)
    {
      LogComponentEnable ("UdpEchoClientApplication", LOG_LEVEL_INFO);
      LogComponentEnable ("UdpEchoServerApplication", LOG_LEVEL_INFO);
    }

  NodeContainer p2pNodes;//创建p2p节点
  p2pNodes.Create (2);

  PointToPointHelper pointToPoint;
  pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
  pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));

  NetDeviceContainer p2pDevices;//创建NetDevice
  p2pDevices = pointToPoint.Install (p2pNodes);

  NodeContainer csmaNodes;//创建CSMA节点，CSMA信道可以连接多个结点，需要结点竞争信道使用权。
  csmaNodes.Add (p2pNodes.Get (1)); //双接口结点，既是p2p，又是CSMA
  csmaNodes.Create (nCsma);  //创建nCsma个CSMA类型结点

  CsmaHelper csma;
  csma.SetChannelAttribute ("DataRate", StringValue ("100Mbps"));//传播速率
  csma.SetChannelAttribute ("Delay", TimeValue (NanoSeconds (6560)));//传播延时为6560ns。

  NetDeviceContainer csmaDevices;
  csmaDevices = csma.Install (csmaNodes);
  //wifi网络设备包括：NetDevice和链路层WifiMac和物理层WifiPhy
  //创建wifi节点
  NodeContainer wifiStaNodes;
  wifiStaNodes.Create (nWifi);
  NodeContainer wifiApNode = p2pNodes.Get (0);
  //1. 设置channel和Wifiphy
  /*Wifi Channel需要配置传播延时和损耗模型，这两个模型加上后面的移动模型一起决定了一个分组在无线信道中的传播延迟和接收功率*/
    
  //设置默认传播延迟和默认损耗
  YansWifiChannelHelper channel = YansWifiChannelHelper::Default (); 
  //默认误码率模型
  YansWifiPhyHelper phy = YansWifiPhyHelper::Default ();
  phy.SetChannel (channel.Create ());
    
  //2. 设置WifiMac并在结点中安装NetDevice，这一步骤需要两个助手类：WifiMacHelper和WifiHelper。 WifiMacHelper需要设置两个重要参数，WifiMac子类(包括AP或移动节点; SSID(AP或移动节点必须服务集一致才能通信)) 
  /*WifiHelper设置了WIfiREmoteStationManager子类类型，WIfiRemoteStationManager主要用于Wifi的速率控制。WifiHelper默认安装的802.11a，也可以通过WifiHelper的SetStandard()函数来选择其他Wifi协议          */
  WifiHelper wifi;
  wifi.SetRemoteStationManager ("ns3::AarfWifiManager");

  WifiMacHelper mac;
  Ssid ssid = Ssid ("ns-3-ssid");
  mac.SetType ("ns3::StaWifiMac", //移动结点
               "Ssid", SsidValue (ssid),
               "ActiveProbing", BooleanValue (false));

  NetDeviceContainer staDevices;
  staDevices = wifi.Install (phy, mac, wifiStaNodes); //安装移动结点

  mac.SetType ("ns3::ApWifiMac",//AP结点
               "Ssid", SsidValue (ssid));

  NetDeviceContainer apDevices;
  apDevices = wifi.Install (phy, mac, wifiApNode);//安装AP结点

    
  //3. 设置移动模型，ns-3使用笛卡尔积标识结点位置。
  MobilityHelper mobility;
  //为移动节点设置移动模型
  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
                                 "MinX", DoubleValue (0.0),//起始坐标(0,0)
                                 "MinY", DoubleValue (0.0),
                                 "DeltaX", DoubleValue (5.0),//X轴结点间距5m
                                 "DeltaY", DoubleValue (10.0),//y轴结点间距10m
                                 "GridWidth", UintegerValue (3),//每行最大节点数
                                 "LayoutType", StringValue ("RowFirst")); //初始位置分布
  mobility.SetMobilityModel ("ns3::RandomWalk2dMobilityModel",
                             "Bounds", RectangleValue (Rectangle (-50, 50, -50, 50))); //移动模型
  mobility.Install (wifiStaNodes);
  
  //为AP结点设置移动模型
  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
  mobility.Install (wifiApNode);

  InternetStackHelper stack;
  stack.Install (csmaNodes);
  stack.Install (wifiApNode);
  stack.Install (wifiStaNodes);

  Ipv4AddressHelper address;

  address.SetBase ("10.1.1.0", "255.255.255.0");
  Ipv4InterfaceContainer p2pInterfaces;
  p2pInterfaces = address.Assign (p2pDevices);

  address.SetBase ("10.1.2.0", "255.255.255.0");
  Ipv4InterfaceContainer csmaInterfaces;
  csmaInterfaces = address.Assign (csmaDevices);

  address.SetBase ("10.1.3.0", "255.255.255.0");
  address.Assign (staDevices);
  address.Assign (apDevices);

  UdpEchoServerHelper echoServer (9);

  ApplicationContainer serverApps = echoServer.Install (csmaNodes.Get (nCsma));
  serverApps.Start (Seconds (1.0));
  serverApps.Stop (Seconds (10.0));

  UdpEchoClientHelper echoClient (csmaInterfaces.GetAddress (nCsma), 9);
  echoClient.SetAttribute ("MaxPackets", UintegerValue (1));
  echoClient.SetAttribute ("Interval", TimeValue (Seconds (1.0)));
  echoClient.SetAttribute ("PacketSize", UintegerValue (1024));

  ApplicationContainer clientApps = 
    echoClient.Install (wifiStaNodes.Get (nWifi - 1));
  clientApps.Start (Seconds (2.0));
  clientApps.Stop (Seconds (10.0));

  Ipv4GlobalRoutingHelper::PopulateRoutingTables ();//全局路由设置

  Simulator::Stop (Seconds (10.0));

  if (tracing == true)
    {
      pointToPoint.EnablePcapAll ("third");
      phy.EnablePcap ("third", apDevices.Get (0));
      csma.EnablePcap ("third", csmaDevices.Get (0), true);
    }

  Simulator::Run ();
  Simulator::Destroy ();
  return 0;
}

输出结果：

这里tracing会生成四个文件：third-0-0；third-0-1；third-1-0；third-1-1

分别表示0结点的p2p接口，WiFi接口；1结点的p2p接口，CSMA接口

Python脚本

得益于Pybindgen，也可以用python语言编写ns-3脚本，其可以调用C++中的API，实现与C++脚本基本相同的功能。

运行python脚本：

1	./waf --pyrun examples/tutorial/first.py

再探ns-3中的脚本：

ns-3中的每一个模块都有自己的助手类。源代码在src/<模块名>/helper目录。

一些主要的ns-3助手如下：

协议层	助手类	操作对象	模块
应用层	BulkSendHelper	TCP分组产生器	application
应用层	PacketSinkHelper	分组接收器	application
应用层	UdpEchoClientHelper	UDP分组产生器	application
传输层，网络层	InternetStackHelper	TCP/IP协议栈	internet
传输层，网络层	Ipv4AddressHelper	IPV4地址分配	internet
传输层，网络层	Ipv4RouteHelper	IPV4路由分配	internet
链路层，物理层	PointToPointHelper	点对点网络设备	point-to-point
链路层，物理层	WifiHelper	Wi-Fi网络设备	wifi
链路层，物理层	MobilityHelper	移动模型	mobility

1. 参数输入：属性变量

输入仿真的参数本质上属性就是C++类中的一个变量，比如下面的声明传输速率和传播延时分别是PointToPointNetDevice和PointToPointChannel类的私有成员变量。

1 2	pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps")); pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));

通过编写脚本配置属性变量的参数，就可以把内部的私有成员变成外部可配置的参数。进而可以仿真不同的网络场景。

2. 配置属性

第一类：助手类，命令行和Config::SetDefault()

可以一次性的给多个对象中的一个属性进行配置。例如first.cc这个例子，但是必须先使用这三种方法声明属性，再创建网络设备。

//先声明属性
PointToPointHelper pointToPoint;
pointToPoint.SetSeviceAttribute("DataRate", StringValue("5Mbps"));
//再创建设备
NetDeviceContainer devices_1;
devices_1 = pointToPoint.Install(nodes);

第二类：ObjectBase::SetAttribute()函数

更精准的属性配置，一次只能配置一个设备的一个属性，ObjectBase是绝大部分网络元素的基类，如Node，Application，NetDevice，Channel。

//获取结点0中PPP网络设备对象
Ptr<NetDevice> dev0 = nodes.Get(0)->GetDevices(0);
//修改传输速率为2.5Mbps
dev0->SetAttribute("DataRate", StringValue("5Mbps"));

Ptr是ns3中的智能指针，Ptr<NetDevice> dev0可以理解为NetDevice* dev0.

第三类：Config::Set函数

更精准的属性配置，一次只能配置多个设备的一个属性，可以看作是前面两个的综合体。这个函数的参数有两个，属性命名空间路径和属性值。

//修改0结点的第0个网络设备
Config::Set(
"/NodeList/0/DeviceList/0\
 /$ns3::PointToPointNetDevice/DateRate",
 StringValue("5Mbps"));

这段代码与第二类中的例子作用完全相同，如果想要一次性表示多个对象，将0换成*即可。

绝大多数对象的配置路径都在/NodeList/或/ChannelList/。

对于一个结点，访问Application对象需要从/Nodelist/<结点序号>/ApplicationList/开始。访问其NetDevice对象需要从/Nodelist/<结点序号>/DeviceList/开始。

3. 读取属性

使用ObjectBase::GetAttribute()函数

//获取结点0中PPP网络设备对象
Ptr<NetDevice> dev0 = nodes.Get(0)->GetDevices(0);
//获取传输速率属性并存储在value变量
StringValue value;
dev0->GetAttribute("DateRate", value);

4. 查找属性

查找模块属性的使用方法最简单的方式就是查看模块的示例代码

此外，还可以在ns-3 documentation中查看。

ns-3： ns-3 文档 (nsnam.org)

在文档中搜索想要的模块，然后点击more即可得到一下信息。

数据输出：trace变量

trace变量本质上是一个函数指针，在使用时，用户需要先定义一个回调函数callback，然后通过trace系统将其与某个C++内部的函数指针相关联。当有特定的网络事件发生时，ns-3就调用相应的trace变量函数指针，进而触发脚本中的回调函数，这样一些重要的模拟数据就会传回给脚本。

trace变量配置方法主要可以分为以下两类：

助手类和Config::Connect()，一次能配置多个trace，通过命名空间路径来获取对象

ObjectBase::TraceConnect,一次只能配置一个trace，直接从代码中获取对象

只能在已经创建的对象上配置trace变量，因为ns-3没有给trace赋予默认值。trace本质是指针，若对象未创建，未分配内存无法配置。

trace一般位于网络拓扑和应用建立以后，Simulator::Run()之前。但也有例外，比如套接字对象。Socket对象是在应用程序启动之后才被创建，因此直接在脚本中为Socket对象的trace变量设置回调函数会引起程序崩溃。一个比较通用的做法是使用Schedule()函数使配置trace的时间点在应用程序启动之后。

具体例子可以参考：

NS3初识——trace回调与first例子的修改_Aomiz_lm的博客-CSDN博客_ns3中trace

此外，也可以通过助手类进行trace配置，本质上就是对上面的函数进行了封装。

查找trace也可以在ns-3： ns-3 文档 (nsnam.org)中找。

通过命令行也可以定义变量值：

1
2
3

./waf --run "third --nWifi=18"
./waf --run "first --ns3::PointToPointNetDevice::DateRate=5Mbps"
./waf --run "first --PrintHelp"

计划事件：Schedule函数

Schedule有三个参数：计划时间延时，事件回调函数指针，事件回调函数参数。

ns-3的log系统：

NS3初识——first.cc与Log系统_Aomiz_lm的博客-CSDN博客

ns-3中的数据跟踪与采集——Logging系统_寻同学的博客-CSDN博客

如果Log系统输出较多可以用下面的命令把Log信息定向输出到一个文本文件中。

1	./waf --run first 2>log.log

网络是怎样模拟的

物理世界中网络的运行是随时间变化的连续过程，ns-3把这些连续变化的网络过程按照时间顺序分割成一系列的离散事件，并按照时间顺序执行这些离散事件。

ns-3 2.6 网络是怎么模拟的_itsdandy的博客-CSDN博客