Attachment #1269 for bug #938

View | Details | Raw Unified | Return to bug 938
Collapse All | Expand All

(-)a/doc/models/source/index.rst (+1 lines)

Lines 40-45	Link Here

   propagation

   propagation

   simple

   simple

   statistics

   statistics

   topology

uan

uan

   wifi

   wifi

   wimax

   wimax




 * - ns3::InetTopologyReader for Inet 3.0 traces (http://topology.eecs.umich.edu/inet/)
 * - ns3::RocketfuelTopologyReader for Rocketfuel traces (http://www.cs.washington.edu/research/networking/rocketfuel/)
 *
 * See the ns-3 modules manual for further informations.
 *
 * A good source for topology data is also Archipelago (http://www.caida.org/projects/ark/)
 *
 * The current Archipelago Measurements, monthly updated, are stored here:
 * http://data.caida.org/datasets/topology/ipv4.allpref24-aslinks/
 * (complete notation and triple data source, one for each working group)
 *
 * A different and more compact notation that signs only the AS-relationships is here:
 * http://www.caida.org/data/active/as-relationships/index.xml
 * (a sort of more Orbis-like format)
 *
 * The compact notation can be easily stripped down to a pure Orbis format, just removing
 * the double relationships (the compact format use one-way links, while Orbis use two-way
 * links) and pruning the 3rd parameter. Note that with the compact data Orbis can then be
 * used create a rescaled version of the topology, thus being the most effective way
 * (to my best knowledge) to make an internet-like topology.
 *
 * Examples can be found in the directory src/topology-read/examples/
 */




.. include:: replace.txt

Topology Input Readers
----------------------

The topology modules aim at reading a topology file generated by an automatic topology generator.
 
The process is divided in two steps:

- running a topology generator to build a topology file
- reading the topology file and build a ns-3 simulation
 
Hence, model is focused on being able to read correctly the various topology formats.
 
Currently there are three models:

* ``ns3::OrbisTopologyReader`` for Orbis_ 0.7 traces 
* ``ns3::InetTopologyReader`` for Inet_ 3.0 traces 
* ``ns3::RocketfuelTopologyReader`` for Rocketfuel_ traces 
 
An helper ``ns3::TopologyReaderHelper`` is provided to assist on trivial tasks.
 
A good source for topology data is also Archipelago_.

The current Archipelago Measurements_, monthly updated, are stored in the CAIDA website using 
a complete notation and triple data source, one for each working group. 

A different and more compact notation reporting only the AS-relationships (a sort of more 
Orbis-like format) is here: as-relationships_.

The compact notation can be easily stripped down to a pure Orbis format, just removing
the double relationships (the compact format use one-way links, while Orbis use two-way
links) and pruning the 3rd parameter. Note that with the compact data Orbis can then be
used create a rescaled version of the topology, thus being the most effective way
(to my best knowledge) to make an internet-like topology.

Examples can be found in the directory ``src/topology-read/examples/``

.. _Orbis: http://sysnet.ucsd.edu/~pmahadevan/topo_research/topo.html
.. _Inet: http://topology.eecs.umich.edu/inet/
.. _RocketFuel: http://www.cs.washington.edu/research/networking/rocketfuel/
.. _Archipelago: http://www.caida.org/projects/ark/
.. _Measurements: http://data.caida.org/datasets/topology/ipv4.allpref24-aslinks/
.. _as-relationships: http://www.caida.org/data/active/as-relationships/index.xml


(-)a/src/topology-read/helper/topology-reader-helper.h (+2 lines)

Lines 28-33	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup topology

 * \brief Helper class which makes it easier to configure and use a generic TopologyReader.

 * \brief Helper class which makes it easier to configure and use a generic TopologyReader.

*/

*/

class TopologyReaderHelper

class TopologyReaderHelper

(-)a/src/topology-read/model/inet-topology-reader.h (-1 / +2 lines)

Lines 23-29	Link Here

#define INET_TOPOLOGY_READER_H

#define INET_TOPOLOGY_READER_H

#include "ns3/nstime.h"

#include "ns3/nstime.h"

#include "topology-reader.h"

#include "topology-reader.h"

namespace ns3 {

namespace ns3 {

Lines 32-37	Link Here

// ------------------------------------------------------------

// ------------------------------------------------------------

// --------------------------------------------

// --------------------------------------------

/**

/**

 * \ingroup topology

 * \brief Topology file reader (Inet-format type).

 * \brief Topology file reader (Inet-format type).

 * This class takes an input file in Inet format and extracts all

 * This class takes an input file in Inet format and extracts all

(-)a/src/topology-read/model/orbis-topology-reader.h (-1 / +2 lines)

Lines 23-29	Link Here

#define ORBIS_TOPOLOGY_READER_H

#define ORBIS_TOPOLOGY_READER_H

#include "ns3/nstime.h"

#include "ns3/nstime.h"

#include "topology-reader.h"

#include "topology-reader.h"

namespace ns3 {

namespace ns3 {

Lines 32-37	Link Here

// ------------------------------------------------------------

// ------------------------------------------------------------

// --------------------------------------------

// --------------------------------------------

/**

/**

 * \ingroup topology

 * \brief Topology file reader (Orbis-format type).

 * \brief Topology file reader (Orbis-format type).

 * This class takes an input file in Orbis format and extracts all

 * This class takes an input file in Orbis format and extracts all

(-)a/src/topology-read/model/rocketfuel-topology-reader.h (-1 / +2 lines)

Lines 22-28	Link Here

#define ROCKETFUEL_TOPOLOGY_READER_H

#define ROCKETFUEL_TOPOLOGY_READER_H

#include "ns3/nstime.h"

#include "ns3/nstime.h"

#include "topology-reader.h"

#include "topology-reader.h"

namespace ns3 {

namespace ns3 {

Lines 31-36	Link Here

// ------------------------------------------------------------

// ------------------------------------------------------------

// --------------------------------------------

// --------------------------------------------

/**

/**

 * \ingroup topology

 * \brief Topology file reader (Rocketfuel-format type).

 * \brief Topology file reader (Rocketfuel-format type).

 * http://www.cs.washington.edu/research/networking/rocketfuel/

 * http://www.cs.washington.edu/research/networking/rocketfuel/

(-)a/src/topology-read/model/topology-reader.h (+12 lines)

Lines 33-38	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup topology

 * \brief Interface for input file readers management.

 * \brief Interface for input file readers management.

 * This interface perform the shared tasks among all possible input file readers.

 * This interface perform the shared tasks among all possible input file readers.

Lines 52-59	Link Here

  class Link

  class Link

public:

public:

/**

   * \brief Constant iterator to scan the map of link attributes.

*/

    typedef std::map<std::string, std::string >::const_iterator ConstAttributesIterator;

    typedef std::map<std::string, std::string >::const_iterator ConstAttributesIterator;

/**

     * \brief Constructor

     * \param fromPtr Ptr to the node the link is orginating from

     * \param fromName name of the node the link is orginating from

     * \param toPtr Ptr to the node the link is directed to

     * \param toName name of the node the link is directed to

*/

    Link ( Ptr<Node> fromPtr, std::string fromName, Ptr<Node> toPtr, std::string toName );

    Link ( Ptr<Node> fromPtr, std::string fromName, Ptr<Node> toPtr, std::string toName );

/**

/**

Return to bug 938