A Discrete-Event Network Simulator
API
brite-topology-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License version 2 as
5  * published by the Free Software Foundation;
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15  *
16  */
17 
18 #ifndef BRITE_TOPOLOGY_HELPER_H
19 #define BRITE_TOPOLOGY_HELPER_H
20 
21 #include <string>
22 #include <vector>
23 
24 #include "ns3/channel.h"
25 #include "ns3/node-container.h"
26 #include "ns3/node-list.h"
27 #include "ns3/point-to-point-helper.h"
28 #include "ns3/internet-stack-helper.h"
29 #include "ns3/ipv6-address-helper.h"
30 #include "ns3/random-variable-stream.h"
31 
32 //located in BRITE source directory
33 #include "Brite.h"
34 
35 namespace ns3 {
36 
37 class PointToPointHelper;
38 
66 {
67 public:
75  BriteTopologyHelper (std::string confFile,
76  std::string seedFile,
77  std::string newseedFile);
78 
84  BriteTopologyHelper (std::string confFile);
85 
87 
95  void AssignStreams (int64_t streamNumber);
96 
103 
111  void BuildBriteTopology (InternetStackHelper& stack, const uint32_t systemCount);
112 
120  uint32_t GetNLeafNodesForAs (uint32_t asNum);
121 
129  Ptr<Node> GetLeafNodeForAs (uint32_t asNum, uint32_t leafNum);
130 
137  uint32_t GetNNodesForAs (uint32_t asNum);
138 
147  Ptr<Node> GetNodeForAs (uint32_t asNum, uint32_t nodeNum);
148 
154  uint32_t GetNAs (void) const;
155 
163  uint32_t GetSystemNumberForAs (uint32_t asNum) const;
164 
171 
178 
185  uint32_t GetNNodesTopology () const;
186 
193  uint32_t GetNEdgesTopology () const;
194 
195 private:
200  static const int mbpsToBps = 1000000;
201 
210  {
211  int nodeId;
212  double xCoordinate;
213  double yCoordinate;
214  int inDegree;
215  int outDegree;
216  int asId;
217  std::string type;
218  };
219 
228  {
229  int edgeId;
230  int srcId;
231  int destId;
232  double length;
233  double delay;
234  double bandwidth;
235  int asFrom;
236  int asTo;
237  std::string type;
238  };
239 
242 
244  void BuildBriteNodeInfoList (void);
246  void BuildBriteEdgeInfoList (void);
248  void ConstructTopology (void);
250  void GenerateBriteTopology (void);
251 
253  std::string m_confFile;
254 
256  std::string m_seedFile;
257 
259  std::string m_newSeedFile;
260 
262  uint32_t m_numAs;
263 
265  std::vector<NetDeviceContainer*> m_netDevices;
266 
268  std::vector<NodeContainer*> m_asLeafNodes;
269 
271  std::vector<NodeContainer*> m_nodesByAs;
272 
274  std::vector<int> m_systemForAs;
275 
277  brite::Topology* m_topology;
278 
280  uint32_t m_numNodes;
281 
283  uint32_t m_numEdges;
284 
291  typedef std::vector<BriteNodeInfo> BriteNodeInfoList;
292  typedef std::vector<BriteEdgeInfo> BriteEdgeInfoList;
293 
300 
303 };
304 
305 } // namespace ns3
306 
307 #endif /* BRITE_TOPOLOGY_HELPER_H */
Interface with BRITE, the Boston university Representative Internet Topology gEnerator.
uint32_t GetNAs(void) const
Returns the number of AS created in the topology.
BriteNodeInfoList m_briteNodeInfoList
The BRITE code generates multiple nodes and edges.
void AssignIpv6Addresses(Ipv6AddressHelper &address)
void AssignStreams(int64_t streamNumber)
Assigns stream number to UniformRandomVariable used to generate brite seed file.
BriteEdgeInfoList m_briteEdgeInfoList
The BRITE code generates multiple nodes and edges.
PointToPointHelper m_britePointToPointHelper
used to create the links within the topology
Ptr< UniformRandomVariable > m_uv
random variable stream for brite seed file
void GenerateBriteTopology(void)
Generate the BRITE topology.
brite::Topology * m_topology
the Brite topology
uint32_t m_numNodes
stores the number of nodes created in the BRITE topology
std::vector< NetDeviceContainer * > m_netDevices
stores the netdevices created for each AS
void ConstructTopology(void)
Construct the topology.
uint32_t m_numEdges
stores the number of edges created in the BRITE topology
uint32_t GetNNodesTopology() const
Returns the number of nodes created within the topology.
void BuildBriteTopology(InternetStackHelper &stack)
Create NS3 topology using information generated from BRITE.
std::vector< NodeContainer * > m_asLeafNodes
stores the leaf router nodes for each AS
std::vector< NodeContainer * > m_nodesByAs
stores all of the nodes in the brite topology by AS number
uint32_t m_numAs
stores the number of AS in the BRITE generated topology
void BuildBriteNodeInfoList(void)
Build the Node Info list.
static const int mbpsToBps
brite values are unitless however all examples provided use mbps to specify rate this constant value ...
Ptr< Node > GetNodeForAs(uint32_t asNum, uint32_t nodeNum)
Returns a given router node for a given AS.
void AssignIpv4Addresses(Ipv4AddressHelper &address)
uint32_t GetNNodesForAs(uint32_t asNum)
Returns the total number of nodes for a given AS.
uint32_t GetNLeafNodesForAs(uint32_t asNum)
Returns the number of router leaf nodes for a given AS.
std::string m_newSeedFile
brite seed file to generate for next run
std::vector< BriteNodeInfo > BriteNodeInfoList
The BRITE code generates multiple nodes and edges.
std::string m_seedFile
brite seed file to use
std::vector< BriteEdgeInfo > BriteEdgeInfoList
The BRITE code generates multiple nodes and edges.
std::vector< int > m_systemForAs
stores the MPI system number each AS assigned to. All assigned to 0 if MPI not used.
NodeContainer m_nodes
stores all of the nodes used in the BRITE generated topology
uint32_t GetNEdgesTopology() const
Returns the number of edges created within the topology.
BriteTopologyHelper(std::string confFile, std::string seedFile, std::string newseedFile)
Construct a BriteTopologyHelper.
Ptr< Node > GetLeafNodeForAs(uint32_t asNum, uint32_t leafNum)
Returns a given router leaf node from a given AS.
void BuildBriteEdgeInfoList(void)
Build the Edge Info list.
uint32_t GetSystemNumberForAs(uint32_t asNum) const
Returns the system number for the MPI instance that this AS is assigned to.
std::string m_confFile
brite configuration file to use
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Helper class to auto-assign global IPv6 unicast addresses.
keep track of a set of node pointers.
Build a set of PointToPointNetDevice objects.
address
Definition: first.py:44
stack
Definition: first.py:41
Every class exported by the ns3 library is enclosed in the ns3 namespace.