brite-topology-helper.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */
 
#ifndef BRITE_TOPOLOGY_HELPER_H
#define BRITE_TOPOLOGY_HELPER_H
 
#include "ns3/channel.h"
#include "ns3/internet-stack-helper.h"
#include "ns3/ipv6-address-helper.h"
#include "ns3/node-container.h"
#include "ns3/node-list.h"
#include "ns3/point-to-point-helper.h"
#include "ns3/random-variable-stream.h"
 
#include <string>
#include <vector>
 
// These are in #include <Brite.h>,
// here we just need a forward declaration.
namespace brite
{
class Topology;
};
 
namespace ns3
{
 
class PointToPointHelper;
class Ipv4AddressHelper;
 
/**
 * \defgroup brite BRITE Topology Generator
 *
 * Create topologies with BRITE.
 */
 
/**
 * \ingroup brite
 * \ingroup tests
 * \defgroup brite-tests BRITE module tests
 */
 
/**
 * \ingroup brite
 * \brief Interface with BRITE, the Boston university Representative Internet
 *        Topology gEnerator
 *
 * This helper class creates an interface with BRITE and allows the user to
 * easily create ns-3 topologies from BRITE generated graphs. This class
 * accepts a BRITE configuration and seed file, much like the stand-alone
 * BRITE software. Using these files, BRITE generates a graph which is
 * stored herein. ns-3 examples can then grab the BRITE generated nodes and
 * edges from this helper and create ns-3 specific topologies.
 *
 */
 
class BriteTopologyHelper
{
  public:
    /**
     * Construct a BriteTopologyHelper
     *
     * \param confFile a BRITE configuration file
     * \param seedFile a BRITE seed file
     * \param newseedFile a BRITE seed file with newly generated values
     */
    BriteTopologyHelper(std::string confFile, std::string seedFile, std::string newseedFile);
 
    /**
     * Construct a BriteTopologyHelper using NS3 to generate seed values
     * need by BRITE
     * \param confFile a BRITE configuration file
     */
    BriteTopologyHelper(std::string confFile);
 
    ~BriteTopologyHelper();
 
    /**
     * Assigns stream number to UniformRandomVariable used to
     * generate brite seed file
     *
     * \param streamNumber the stream number to assign
     */
    void AssignStreams(int64_t streamNumber);
 
    /**
     * Create NS3 topology using information generated from BRITE.
     *
     * \param stack Internet stack to assign to nodes in topology
     */
    void BuildBriteTopology(InternetStackHelper& stack);
 
    /**
     * Create NS3 topology using information generated from BRITE and configure topology for MPI
     * use.
     *
     * \param stack Internet stack to assign to nodes in topology.
     * \param systemCount The number of MPI instances to be used in the simulation.
     */
    void BuildBriteTopology(InternetStackHelper& stack, const uint32_t systemCount);
 
    /**
     * Returns the number of router leaf nodes for a given AS
     *
     * \param asNum the AS number
     * \returns the number of leaf nodes in the specified AS
     */
    uint32_t GetNLeafNodesForAs(uint32_t asNum);
 
    /**
     * Returns a given router leaf node from a given AS
     *
     * \param asNum the AS number
     * \param leafNum the leaf number
     * \returns the specified node
     */
    Ptr<Node> GetLeafNodeForAs(uint32_t asNum, uint32_t leafNum);
 
    /**
     * Returns the total number of nodes for a given AS
     *
     * \param asNum the AS number
     * \returns the total number of nodes in the given AS
     */
    uint32_t GetNNodesForAs(uint32_t asNum);
 
    /**
     * Returns a given router node for a given AS
     *
     * \param asNum the AS number
     * \param nodeNum the Node number
     * \return the specified node
     */
    Ptr<Node> GetNodeForAs(uint32_t asNum, uint32_t nodeNum);
 
    /**
     * Returns the number of AS created in the topology
     *
     * \returns the number of AS created in the topology
     */
    uint32_t GetNAs() const;
 
    /**
     * Returns the system number for the MPI instance that this AS is assigned to.  Will always
     * return 0 if MPI not used
     *
     * \returns The system number that the specified AS number belongs to
     *
     * \param asNum The AS Number
     */
    uint32_t GetSystemNumberForAs(uint32_t asNum) const;
 
    /**
     * Assign IPv4 addresses.
     *
     * \param address an Ipv4AddressHelper which is used to install
     *                IPv4 addresses on all the node interfaces in
     *                the topology
     */
    void AssignIpv4Addresses(Ipv4AddressHelper& address);
 
    /**
     * Assign IPv6 addresses.
     *
     * \param address an Ipv6AddressHelper which is used to install
     *                IPv6 addresses on all the node interfaces in
     *                the topology
     */
    void AssignIpv6Addresses(Ipv6AddressHelper& address);
 
    /**
     * Returns the number of nodes created within
     * the topology
     *
     * \returns the total number of nodes within the brite topology
     */
    uint32_t GetNNodesTopology() const;
 
    /**
     * Returns the number of edges created within
     * the topology
     *
     * \returns the total number of edges within the brite topology
     */
    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;
 
    /**
     * \brief Node information from BRITE
     *
     * The BRITE code generates a graph and returns
     * information on the nodes generated. This is
     * stored here in a struct.
     */
    struct BriteNodeInfo
    {
        int nodeId;         //!< Node ID
        double xCoordinate; //!< X coordinate
        double yCoordinate; //!< Y coordinate
        int inDegree;       //!< Ingress (IN) degree
        int outDegree;      //!< Egress (OUT) degree
        int asId;           //!< AS ID
        std::string type;   //!< Node type
    };
 
    /**
     * \brief Edge information from BRITE
     *
     * The BRITE code generates a graph and returns
     * information on the edges generated. This is
     * stored here in a struct.
     */
    struct BriteEdgeInfo
    {
        int edgeId;       //!< Edge ID
        int srcId;        //!< Src node ID
        int destId;       //!< Dst node ID
        double length;    //!< Length
        double delay;     //!< Delay
        double bandwidth; //!< Bandwidth
        int asFrom;       //!< Originating AS
        int asTo;         //!< Destination AS
        std::string type; //!< Edge type
    };
 
    /// stores all of the nodes used in the BRITE generated topology
    NodeContainer m_nodes;
 
    /// Build the Node Info list
    void BuildBriteNodeInfoList();
    /// Build the Edge Info list
    void BuildBriteEdgeInfoList();
    /// Construct the topology.
    void ConstructTopology();
    /// Generate the BRITE topology.
    void GenerateBriteTopology();
 
    /// brite configuration file to use
    std::string m_confFile;
 
    /// brite seed file to use
    std::string m_seedFile;
 
    /// brite seed file to generate for next run
    std::string m_newSeedFile;
 
    /// stores the number of AS in the BRITE generated topology
    uint32_t m_numAs;
 
    /// stores the netdevices created for each AS
    std::vector<NetDeviceContainer*> m_netDevices;
 
    /// stores the leaf router nodes for each AS
    std::vector<NodeContainer*> m_asLeafNodes;
 
    /// stores all of the nodes in the brite topology by AS number
    std::vector<NodeContainer*> m_nodesByAs;
 
    /// stores the MPI system number each AS assigned to.  All assigned to 0 if MPI not used.
    std::vector<int> m_systemForAs;
 
    /// the Brite topology
    brite::Topology* m_topology;
 
    /// stores the number of nodes created in the BRITE topology
    uint32_t m_numNodes;
 
    /// stores the number of edges created in the BRITE topology
    uint32_t m_numEdges;
 
    /**
     * The BRITE code generates multiple nodes and edges. Each
     * node and edge is stored in a BriteNodeInfo or BriteEdgeInfo
     * struct, and each instance is stored in a vector.
     * @{
     */
    typedef std::vector<BriteNodeInfo> BriteNodeInfoList;
    typedef std::vector<BriteEdgeInfo> BriteEdgeInfoList;
 
    BriteNodeInfoList m_briteNodeInfoList;
    BriteEdgeInfoList m_briteEdgeInfoList;
    /**@}*/
 
    /// used to create the links within the topology
    PointToPointHelper m_britePointToPointHelper;
 
    /// random variable stream for brite seed file
    Ptr<UniformRandomVariable> m_uv;
};
 
} // namespace ns3
 
#endif /* BRITE_TOPOLOGY_HELPER_H */