Singleton used to interface to the communications infrastructure when running NS3 in parallel. More...

#include "mpi-interface.h"

Collaboration diagram for ns3::MpiInterface:

Static Public Member Functions
static void	Destroy ()
	Deletes storage used by the parallel environment.

static void	Disable ()
	Clean up the ns-3 parallel communications interface.

static void	Enable (int pargc, char **pargv)
	Setup the parallel communication interface.

static void	Enable (MPI_Comm communicator)
	Setup the parallel communication interface using the specified communicator.

static MPI_Comm	GetCommunicator ()
	Return the communicator used to run ns-3.

static uint32_t	GetSize ()
	Get the number of ranks used by ns-3.

static uint32_t	GetSystemId ()
	Get the id number of this rank.

static bool	IsEnabled ()
	Returns enabled state of parallel environment.

static void	SendPacket (Ptr< Packet > p, const Time &rxTime, uint32_t node, uint32_t dev)
	Send a packet to a remote node.

Static Private Member Functions
static void	SetParallelSimulatorImpl ()
	Common enable logic.

Static Private Attributes
static ParallelCommunicationInterface *	g_parallelCommunicationInterface = nullptr
	Static instance of the instantiated parallel controller.

Detailed Description

Singleton used to interface to the communications infrastructure when running NS3 in parallel.

Delegates the implementation to the specific parallel infrastructure being used. Implementation is defined in the ParallelCommunicationInterface virtual base class; this API mirrors that interface. This singleton is responsible for instantiating an instance of the communication interface based on SimulatorImplementationType attribute in ns3::GlobalValues. The attribute must be set before Enable is invoked.

Definition at line 51 of file mpi-interface.h.

Member Function Documentation

◆ Destroy()

void ns3::MpiInterface::Destroy ( )

static

Deletes storage used by the parallel environment.

Definition at line 32 of file mpi-interface.cc.

References ns3::ParallelCommunicationInterface::Destroy(), g_parallelCommunicationInterface, and NS_ASSERT.

Referenced by ns3::DistributedSimulatorImpl::Destroy(), and ns3::NullMessageSimulatorImpl::Destroy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Disable()

void ns3::MpiInterface::Disable ( )

static

Clean up the ns-3 parallel communications interface.

MPI_Finalize will be called only if Enable (int* pargc, char*** pargv) was called.

Definition at line 142 of file mpi-interface.cc.

References ns3::ParallelCommunicationInterface::Disable(), g_parallelCommunicationInterface, and NS_ASSERT.

Here is the call graph for this function:

◆ Enable() [1/2]

void ns3::MpiInterface::Enable	(	int *	pargc,
		char ***	pargv )

static

Setup the parallel communication interface.

There are two ways to setup the communications interface. This Enable method is the easiest method and should be used in most situations.

Disable() must be invoked at end of an ns-3 application to properly cleanup the parallel communication interface.

This method will call MPI_Init and configure ns-3 to use the MPI_COMM_WORLD communicator.

For more complex situations, such as embedding ns-3 with other MPI simulators or libraries, the Enable(MPI_Comm communcicator) may be used if MPI is initialized externally or if ns-3 needs to be run unique communicator. For example if there are two parallel simulators and the goal is to run each simulator on a different set of ranks.

Note: The `SimulatorImplementationType attribute in ns3::GlobalValues must be set before calling Enable()

Parameters

pargc	number of command line arguments
pargv	command line arguments

Definition at line 113 of file mpi-interface.cc.

References ns3::ParallelCommunicationInterface::Enable(), g_parallelCommunicationInterface, and SetParallelSimulatorImpl().

Here is the call graph for this function:

◆ Enable() [2/2]

void ns3::MpiInterface::Enable ( MPI_Comm communicator )

static

Setup the parallel communication interface using the specified communicator.

See Enable (int* pargc, char*** pargv) for additional information.

Parameters

communicator MPI Communicator that should be used by ns-3

Definition at line 121 of file mpi-interface.cc.

References ns3::ParallelCommunicationInterface::Enable(), g_parallelCommunicationInterface, and SetParallelSimulatorImpl().

Here is the call graph for this function:

◆ GetCommunicator()

MPI_Comm ns3::MpiInterface::GetCommunicator ( )

static

Return the communicator used to run ns-3.

The communicator returned will be MPI_COMM_WORLD if Enable (int* pargc, char*** pargv) is used to enable or the user specified communicator if Enable (MPI_Comm communicator) is used.