A Discrete-Event Network Simulator
API
brite-MPI-example.cc
Go to the documentation of this file.
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License version 2 as
4  * published by the Free Software Foundation;
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9  * GNU General Public License for more details.
10  *
11  * You should have received a copy of the GNU General Public License
12  * along with this program; if not, write to the Free Software
13  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
14  *
15  */
16 
17 #include "Brite.h"
18 
19 #include "ns3/applications-module.h"
20 #include "ns3/brite-module.h"
21 #include "ns3/core-module.h"
22 #include "ns3/internet-module.h"
23 #include "ns3/mobility-module.h"
24 #include "ns3/mpi-interface.h"
25 #include "ns3/network-module.h"
26 #include "ns3/nix-vector-helper.h"
27 #include "ns3/point-to-point-module.h"
28 
29 #include <fstream>
30 #include <iostream>
31 #include <string>
32 
33 #ifdef NS3_MPI
34 #include <mpi.h>
35 #endif
36 
37 using namespace ns3;
38 
39 NS_LOG_COMPONENT_DEFINE("BriteMPITest");
40 
41 int
42 main(int argc, char* argv[])
43 {
44 #ifdef NS3_MPI
45  // Distributed simulation setup
46  MpiInterface::Enable(&argc, &argv);
47  GlobalValue::Bind("SimulatorImplementationType", StringValue("ns3::DistributedSimulatorImpl"));
48 
49  LogComponentEnable("BriteMPITest", LOG_LEVEL_ALL);
50  LogComponentEnable("TcpSocketBase", LOG_LEVEL_INFO);
51 
52  uint32_t systemId = MpiInterface::GetSystemId();
53  uint32_t systemCount = MpiInterface::GetSize();
54 
55  // Check for valid distributed parameters.
56  // For just this particular example, must have 2 and only 2 Logical Processors (LPs)
57  NS_ASSERT_MSG(systemCount == 2, "This demonstration requires 2 and only 2 logical processors.");
58 
59  // BRITE needs a configuration file to build its graph. By default, this
60  // example will use the TD_ASBarabasi_RTWaxman.conf file. There are many others
61  // which can be found in the BRITE/conf_files directory
62  std::string confFile = "src/brite/examples/conf_files/TD_ASBarabasi_RTWaxman.conf";
63  bool tracing = false;
64  bool nix = false;
65 
66  CommandLine cmd(__FILE__);
67  cmd.AddValue("confFile", "BRITE conf file", confFile);
68  cmd.AddValue("tracing", "Enable or disable ascii tracing", tracing);
69  cmd.AddValue("nix", "Enable or disable nix-vector routing", nix);
70 
71  cmd.Parse(argc, argv);
72 
73  // Invoke the BriteTopologyHelper and pass in a BRITE
74  // configuration file and a seed file. This will use
75  // BRITE to build a graph from which we can build the ns-3 topology
76  BriteTopologyHelper bth(confFile);
77 
79 
81 
82  if (nix)
83  {
84  Ipv4NixVectorHelper nixRouting;
85  stack.SetRoutingHelper(nixRouting);
86  }
87 
89  address.SetBase("10.0.0.0", "255.255.255.252");
90 
91  // build topology as normal but also pass systemCount
92  bth.BuildBriteTopology(stack, systemCount);
93  bth.AssignIpv4Addresses(address);
94 
95  NS_LOG_LOGIC("Number of AS created " << bth.GetNAs());
96 
97  uint16_t port = 5001;
98 
99  NodeContainer client;
100  NodeContainer server;
101 
102  // For this example will use AS 0 and AS 1 which will be on separate systems
103  // due to the mod divide used to assign AS to system.
104 
105  // GetSystemNumberForAs (uint32_t) can be used to determine which system an
106  // AS is assigned to
107  NS_LOG_LOGIC("AS 0 has been assigned to system " << bth.GetSystemNumberForAs(0));
108  NS_LOG_LOGIC("As 1 has been assigned to system " << bth.GetSystemNumberForAs(1));
109 
110  // install client node on last leaf node of AS 0
111  client.Add(CreateObject<Node>(0));
112  stack.Install(client);
113  int numLeafNodesInAsZero = bth.GetNLeafNodesForAs(0);
114  client.Add(bth.GetLeafNodeForAs(0, numLeafNodesInAsZero - 1));
115 
116  // install server node on last leaf node on AS 1
117  server.Add(CreateObject<Node>(1));
118  stack.Install(server);
119  int numLeafNodesInAsOne = bth.GetNLeafNodesForAs(1);
120  server.Add(bth.GetLeafNodeForAs(1, numLeafNodesInAsOne - 1));
121 
122  p2p.SetDeviceAttribute("DataRate", StringValue("5Mbps"));
123  p2p.SetChannelAttribute("Delay", StringValue("2ms"));
124 
125  NetDeviceContainer p2pClientDevices;
126  NetDeviceContainer p2pServerDevices;
127 
128  p2pClientDevices = p2p.Install(client);
129  p2pServerDevices = p2p.Install(server);
130 
131  address.SetBase("10.1.0.0", "255.255.0.0");
132  Ipv4InterfaceContainer clientInterfaces;
133  clientInterfaces = address.Assign(p2pClientDevices);
134 
135  address.SetBase("10.2.0.0", "255.255.0.0");
136  Ipv4InterfaceContainer serverInterfaces;
137  serverInterfaces = address.Assign(p2pServerDevices);
138 
139  if (!nix)
140  {
142  }
143 
144  // only has two systems in this example. Install applications only on nodes in my system
145 
146  // Moved here to get totalRX at end
147  ApplicationContainer sinkApps;
148 
149  if (systemId == 1)
150  {
151  Address sinkLocalAddress(InetSocketAddress(Ipv4Address::GetAny(), port));
152  PacketSinkHelper packetSinkHelper("ns3::TcpSocketFactory", sinkLocalAddress);
153  sinkApps.Add(packetSinkHelper.Install(server.Get(0)));
154  sinkApps.Start(Seconds(0.0));
155  sinkApps.Stop(Seconds(10.0));
156  }
157 
158  if (systemId == 0)
159  {
160  OnOffHelper clientHelper("ns3::TcpSocketFactory", Address());
161  clientHelper.SetAttribute("OnTime", StringValue("ns3::ConstantRandomVariable[Constant=1]"));
162  clientHelper.SetAttribute("OffTime",
163  StringValue("ns3::ConstantRandomVariable[Constant=0]"));
164 
166  AddressValue remoteAddress(InetSocketAddress(serverInterfaces.GetAddress(0), port));
167  clientHelper.SetAttribute("Remote", remoteAddress);
168  clientApps.Add(clientHelper.Install(client.Get(0)));
169  clientApps.Start(Seconds(1.0)); // Start 1 second after sink
170  clientApps.Stop(Seconds(9.0)); // Stop before the sink
171  }
172 
173  if (!nix)
174  {
176  }
177 
178  if (tracing)
179  {
180  AsciiTraceHelper ascii;
181  p2p.EnableAsciiAll(ascii.CreateFileStream("briteLeaves.tr"));
182  }
183 
184  // Run the simulator
185  Simulator::Stop(Seconds(200.0));
186  Simulator::Run();
188 
189  if (systemId == 1)
190  {
191  Ptr<PacketSink> sink1 = DynamicCast<PacketSink>(sinkApps.Get(0));
192  NS_LOG_DEBUG("Total Bytes Received: " << sink1->GetTotalRx());
193  }
194 
196 
197  return 0;
198 
199 #else
200  NS_FATAL_ERROR("Can't use distributed simulator without MPI compiled in");
201 #endif
202 }
a polymophic address class
Definition: address.h:100
AttributeValue implementation for Address.
holds a vector of ns3::Application pointers.
void Start(Time start) const
Start all of the Applications in this container at the start time given as a parameter.
Ptr< Application > Get(uint32_t i) const
Get the Ptr<Application> stored in this container at a given index.
void Stop(Time stop) const
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter.
void Add(ApplicationContainer other)
Append the contents of another ApplicationContainer to the end of this container.
void EnableAsciiAll(std::string prefix)
Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes c...
Manage ASCII trace files for device models.
Definition: trace-helper.h:173
Ptr< OutputStreamWrapper > CreateFileStream(std::string filename, std::ios::openmode filemode=std::ios::out)
Create and initialize an output stream object we'll use to write the traced bits.
Interface with BRITE, the Boston university Representative Internet Topology gEnerator.
Parse command-line arguments.
Definition: command-line.h:232
static void Bind(std::string name, const AttributeValue &value)
Iterate over the set of GlobalValues until a matching name is found and then set its value with Globa...
an Inet address class
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
static Ipv4Address GetAny()
static void PopulateRoutingTables()
Build a routing database and initialize the routing tables of the nodes in the simulation.
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
static uint32_t GetSystemId()
Get the id number of this rank.
static uint32_t GetSize()
Get the number of ranks used by ns-3.
static void Disable()
Clean up the ns-3 parallel communications interface.
static void Enable(int *pargc, char ***pargv)
Setup the parallel communication interface.
holds a vector of ns3::NetDevice pointers
Helper class that adds Nix-vector routing to nodes.
keep track of a set of node pointers.
void Add(const NodeContainer &nc)
Append the contents of another NodeContainer to the end of this container.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:44
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
uint64_t GetTotalRx() const
Definition: packet-sink.cc:96
Build a set of PointToPointNetDevice objects.
void SetDeviceAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each NetDevice created by the helper.
void SetChannelAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each Channel created by the helper.
NetDeviceContainer Install(NodeContainer c)
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:140
static void Run()
Run the simulation.
Definition: simulator.cc:176
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:184
Hold variables of type string.
Definition: string.h:56
uint16_t port
Definition: dsdv-manet.cc:45
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition: assert.h:86
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:179
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:268
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:282
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1336
address
Definition: first.py:40
clientApps
Definition: first.py:58
stack
Definition: first.py:37
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void LogComponentEnable(const std::string &name, LogLevel level)
Enable the logging output associated with that log component.
Definition: log.cc:305
@ LOG_LEVEL_ALL
Print everything.
Definition: log.h:116
@ LOG_LEVEL_INFO
LOG_INFO and above.
Definition: log.h:107
cmd
Definition: second.py:33
bool tracing
Flag to enable/disable generation of tracing files.