brite-topology-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef BRITE_TOPOLOGY_HELPER_H
#define BRITE_TOPOLOGY_HELPER_H

#include <string>
#include <vector>

#include "ns3/channel.h"
#include "ns3/node-container.h"
#include "ns3/node-list.h"
#include "ns3/point-to-point-helper.h"
#include "ns3/internet-stack-helper.h"
#include "ns3/ipv6-address-helper.h"
#include "ns3/random-variable-stream.h"

//located in BRITE source directory
#include "Brite.h"

namespace ns3 {

class PointToPointHelper;

class BriteTopologyHelper
{
public:
  BriteTopologyHelper (std::string confFile,
                       std::string seedFile,
                       std::string newseedFile);

  BriteTopologyHelper (std::string confFile);

  ~BriteTopologyHelper ();

  void AssignStreams (int64_t streamNumber);

  void BuildBriteTopology (InternetStackHelper& stack);

  void BuildBriteTopology (InternetStackHelper& stack, const uint32_t systemCount);

  uint32_t GetNLeafNodesForAs (uint32_t asNum);

  Ptr<Node> GetLeafNodeForAs (uint32_t asNum, uint32_t leafNum);

  uint32_t GetNNodesForAs (uint32_t asNum);

  Ptr<Node> GetNodeForAs (uint32_t asNum, uint32_t nodeNum);

  uint32_t GetNAs (void) const;

  uint32_t GetSystemNumberForAs (uint32_t asNum) const;

  void AssignIpv4Addresses (Ipv4AddressHelper& address);

  void AssignIpv6Addresses (Ipv6AddressHelper& address);

  uint32_t GetNNodesTopology () const;

  uint32_t GetNEdgesTopology () const;

private:
  //brite values are unitless however all examples provided use mbps to specify rate
  //this constant value is used to convert the mbps provided by brite to bps.
  static const int mbpsToBps = 1000000;

  struct BriteNodeInfo
  {
    int nodeId;
    double xCoordinate;
    double yCoordinate;
    int inDegree;
    int outDegree;
    int asId;
    std::string type;
  };

  struct BriteEdgeInfo
  {
    int edgeId;
    int srcId;
    int destId;
    double length;
    double delay;
    double bandwidth;
    int asFrom;
    int asTo;
    std::string type;
  };

  //stores all of the nodes used in the BRITE generated topology
  NodeContainer m_nodes;

  void BuildBriteNodeInfoList (void);
  void BuildBriteEdgeInfoList (void);
  void ConstructTopology (void);
  void GenerateBriteTopology (void);

  std::string m_confFile;

  std::string m_seedFile;

  std::string m_newSeedFile;

  uint32_t m_numAs;

  std::vector<NetDeviceContainer*> m_netDevices;

  std::vector<NodeContainer*> m_asLeafNodes;

  std::vector<NodeContainer*> m_nodesByAs;

  std::vector<int> m_systemForAs;

  brite::Topology* m_topology;

  uint32_t m_numNodes;

  uint32_t m_numEdges;

  typedef std::vector<BriteNodeInfo> BriteNodeInfoList;
  typedef std::vector<BriteEdgeInfo> BriteEdgeInfoList;

  BriteNodeInfoList m_briteNodeInfoList;
  BriteEdgeInfoList m_briteEdgeInfoList;
  PointToPointHelper m_britePointToPointHelper;

  Ptr<UniformRandomVariable> m_uv;
};

} // namespace ns3

#endif /* BRITE_TOPOLOGY_HELPER_H */