A Discrete-Event Network Simulator
API
brite-MPI-example.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012 The Georgia Institute of Technology
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Brian Swenson <bswenson3@gatech.edu>
18  */
19 
20 #include "Brite.h"
21 
22 #include "ns3/applications-module.h"
23 #include "ns3/brite-module.h"
24 #include "ns3/core-module.h"
25 #include "ns3/internet-module.h"
26 #include "ns3/mobility-module.h"
27 #include "ns3/mpi-interface.h"
28 #include "ns3/network-module.h"
29 #include "ns3/nix-vector-helper.h"
30 #include "ns3/point-to-point-module.h"
31 
32 #include <fstream>
33 #include <iostream>
34 #include <string>
35 
36 #ifdef NS3_MPI
37 #include <mpi.h>
38 #endif
39 
40 using namespace ns3;
41 
42 NS_LOG_COMPONENT_DEFINE("BriteMPITest");
43 
44 int
45 main(int argc, char* argv[])
46 {
47 #ifdef NS3_MPI
48  // Distributed simulation setup
49  MpiInterface::Enable(&argc, &argv);
50  GlobalValue::Bind("SimulatorImplementationType", StringValue("ns3::DistributedSimulatorImpl"));
51 
52  LogComponentEnable("BriteMPITest", LOG_LEVEL_ALL);
53  LogComponentEnable("TcpSocketBase", LOG_LEVEL_INFO);
54 
55  uint32_t systemId = MpiInterface::GetSystemId();
56  uint32_t systemCount = MpiInterface::GetSize();
57 
58  // Check for valid distributed parameters.
59  // For just this particular example, must have 2 and only 2 Logical Processors (LPs)
60  NS_ASSERT_MSG(systemCount == 2, "This demonstration requires 2 and only 2 logical processors.");
61 
62  // BRITE needs a configuration file to build its graph. By default, this
63  // example will use the TD_ASBarabasi_RTWaxman.conf file. There are many others
64  // which can be found in the BRITE/conf_files directory
65  std::string confFile = "src/brite/examples/conf_files/TD_ASBarabasi_RTWaxman.conf";
66  bool tracing = false;
67  bool nix = false;
68 
69  CommandLine cmd(__FILE__);
70  cmd.AddValue("confFile", "BRITE conf file", confFile);
71  cmd.AddValue("tracing", "Enable or disable ascii tracing", tracing);
72  cmd.AddValue("nix", "Enable or disable nix-vector routing", nix);
73 
74  cmd.Parse(argc, argv);
75 
76  // Invoke the BriteTopologyHelper and pass in a BRITE
77  // configuration file and a seed file. This will use
78  // BRITE to build a graph from which we can build the ns-3 topology
80 
82 
84 
85  if (nix)
86  {
88  stack.SetRoutingHelper(nixRouting);
89  }
90 
92  address.SetBase("10.0.0.0", "255.255.255.252");
93 
94  // build topology as normal but also pass systemCount
95  bth.BuildBriteTopology(stack, systemCount);
96  bth.AssignIpv4Addresses(address);
97 
98  NS_LOG_LOGIC("Number of AS created " << bth.GetNAs());
99 
100  uint16_t port = 5001;
101 
104 
105  // For this example will use AS 0 and AS 1 which will be on separate systems
106  // due to the mod divide used to assign AS to system.
107 
108  // GetSystemNumberForAs (uint32_t) can be used to determine which system an
109  // AS is assigned to
110  NS_LOG_LOGIC("AS 0 has been assigned to system " << bth.GetSystemNumberForAs(0));
111  NS_LOG_LOGIC("As 1 has been assigned to system " << bth.GetSystemNumberForAs(1));
112 
113  // install client node on last leaf node of AS 0
114  client.Add(CreateObject<Node>(0));
115  stack.Install(client);
116  int numLeafNodesInAsZero = bth.GetNLeafNodesForAs(0);
117  client.Add(bth.GetLeafNodeForAs(0, numLeafNodesInAsZero - 1));
118 
119  // install server node on last leaf node on AS 1
120  server.Add(CreateObject<Node>(1));
121  stack.Install(server);
122  int numLeafNodesInAsOne = bth.GetNLeafNodesForAs(1);
123  server.Add(bth.GetLeafNodeForAs(1, numLeafNodesInAsOne - 1));
124 
125  p2p.SetDeviceAttribute("DataRate", StringValue("5Mbps"));
126  p2p.SetChannelAttribute("Delay", StringValue("2ms"));
127 
130 
131  p2pClientDevices = p2p.Install(client);
132  p2pServerDevices = p2p.Install(server);
133 
134  address.SetBase("10.1.0.0", "255.255.0.0");
137 
138  address.SetBase("10.2.0.0", "255.255.0.0");
141 
142  if (!nix)
143  {
145  }
146 
147  // only has two systems in this example. Install applications only on nodes in my system
148 
149  // Moved here to get totalRX at end
150  ApplicationContainer sinkApps;
151 
152  if (systemId == 1)
153  {
154  Address sinkLocalAddress(InetSocketAddress(Ipv4Address::GetAny(), port));
155  PacketSinkHelper packetSinkHelper("ns3::TcpSocketFactory", sinkLocalAddress);
156  sinkApps.Add(packetSinkHelper.Install(server.Get(0)));
157  sinkApps.Start(Seconds(0.0));
158  sinkApps.Stop(Seconds(10.0));
159  }
160 
161  if (systemId == 0)
162  {
163  OnOffHelper clientHelper("ns3::TcpSocketFactory", Address());
164  clientHelper.SetAttribute("OnTime", StringValue("ns3::ConstantRandomVariable[Constant=1]"));
165  clientHelper.SetAttribute("OffTime",
166  StringValue("ns3::ConstantRandomVariable[Constant=0]"));
167 
169  AddressValue remoteAddress(InetSocketAddress(serverInterfaces.GetAddress(0), port));
170  clientHelper.SetAttribute("Remote", remoteAddress);
171  clientApps.Add(clientHelper.Install(client.Get(0)));
172  clientApps.Start(Seconds(1.0)); // Start 1 second after sink
173  clientApps.Stop(Seconds(9.0)); // Stop before the sink
174  }
175 
176  if (!nix)
177  {
179  }
180 
181  if (tracing)
182  {
183  AsciiTraceHelper ascii;
184  p2p.EnableAsciiAll(ascii.CreateFileStream("briteLeaves.tr"));
185  }
186 
187  // Run the simulator
188  Simulator::Stop(Seconds(200.0));
189  Simulator::Run();
191 
192  if (systemId == 1)
193  {
194  Ptr<PacketSink> sink1 = DynamicCast<PacketSink>(sinkApps.Get(0));
195  NS_LOG_DEBUG("Total Bytes Received: " << sink1->GetTotalRx());
196  }
197 
199 
200  return 0;
201 
202 #else
203  NS_FATAL_ERROR("Can't use distributed simulator without MPI compiled in");
204 #endif
205 }
a polymophic address class
Definition: address.h:101
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.
Manage ASCII trace files for device models.
Definition: trace-helper.h:174
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.
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.
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.
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
static void Run()
Run the simulation.
Definition: simulator.cc:178
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:186
Hold variables of type string.
Definition: string.h:56
uint16_t port
Definition: dsdv-manet.cc:44
#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:1326
address
Definition: first.py:47
clientApps
Definition: first.py:64
stack
Definition: first.py:44
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:302
@ LOG_LEVEL_ALL
Print everything.
Definition: log.h:116
@ LOG_LEVEL_INFO
LOG_INFO and above.
Definition: log.h:104
cmd
Definition: second.py:40
bool tracing
Flag to enable/disable generation of tracing files.