A Discrete-Event Network Simulator
API
mpi-interface.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright 2013. Lawrence Livermore National Security, LLC.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Steven Smith <smith84@llnl.gov>
19  */
20 
27 #ifndef NS3_MPI_INTERFACE_H
28 #define NS3_MPI_INTERFACE_H
29 
30 #include <ns3/nstime.h>
31 #include <ns3/packet.h>
32 
33 #include "mpi.h"
34 
35 namespace ns3 {
46 class ParallelCommunicationInterface;
47 
62 class MpiInterface
63 {
64 public:
68  static void Destroy ();
76  static uint32_t GetSystemId ();
86  static uint32_t GetSize ();
92  static bool IsEnabled ();
119  static void Enable (int* pargc, char*** pargv);
127  static void Enable (MPI_Comm communicator);
134  static void Disable ();
145  static void SendPacket (Ptr<Packet> p, const Time &rxTime, uint32_t node, uint32_t dev);
146 
156  static MPI_Comm GetCommunicator();
157 
158 private:
159 
163  static void SetParallelSimulatorImpl (void);
164 
168  static ParallelCommunicationInterface* g_parallelCommunicationInterface;
169 };
170 
171 } // namespace ns3
172 
173 #endif /* NS3_MPI_INTERFACE_H */
ns3::MpiInterface
Singleton used to interface to the communications infrastructure when running NS3 in parallel.
Definition: mpi-interface.h:63
ns3::MpiInterface::g_parallelCommunicationInterface
static ParallelCommunicationInterface * g_parallelCommunicationInterface
Static instance of the instantiated parallel controller.
Definition: mpi-interface.h:168
ns3::MpiInterface::GetCommunicator
static MPI_Comm GetCommunicator()
Return the communicator used to run ns-3.
Definition: mpi-interface.cc:138
ns3::MpiInterface::SendPacket
static void SendPacket(Ptr< Packet > p, const Time &rxTime, uint32_t node, uint32_t dev)
Send a packet to a remote node.
Definition: mpi-interface.cc:131
ns3::MpiInterface::IsEnabled
static bool IsEnabled()
Returns enabled state of parallel environment.
Definition: mpi-interface.cc:68
ns3::MpiInterface::Destroy
static void Destroy()
Deletes storage used by the parallel environment.
Definition: mpi-interface.cc:43
ns3::MpiInterface::SetParallelSimulatorImpl
static void SetParallelSimulatorImpl(void)
Common enable logic.
Definition: mpi-interface.cc:81
ns3::MpiInterface::GetSystemId
static uint32_t GetSystemId()
Get the id number of this rank.
Definition: mpi-interface.cc:50
ns3::MpiInterface::GetSize
static uint32_t GetSize()
Get the number of ranks used by ns-3.
Definition: mpi-interface.cc:59
ns3::MpiInterface::Disable
static void Disable()
Clean up the ns-3 parallel communications interface.
Definition: mpi-interface.cc:146
ns3::MpiInterface::Enable
static void Enable(int *pargc, char ***pargv)
Setup the parallel communication interface.
Definition: mpi-interface.cc:115
ns3::ParallelCommunicationInterface
Pure virtual base class for the interface between ns-3 and the parallel communication layer being use...
Definition: parallel-communication-interface.h:60
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.