null-message-mpi-interface.h

Go to the documentation of this file.

/*
 *  Copyright 2013. Lawrence Livermore National Security, LLC.
 *
 * 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
 *
 * Author: Steven Smith <smith84@llnl.gov>
 */
 
#ifndef NS3_NULLMESSAGE_MPI_INTERFACE_H
#define NS3_NULLMESSAGE_MPI_INTERFACE_H
 
#include "parallel-communication-interface.h"
 
#include <ns3/buffer.h>
#include <ns3/nstime.h>
 
#include <list>
#include <mpi.h>
 
namespace ns3
{
 
class NullMessageSimulatorImpl;
class NullMessageSentBuffer;
class RemoteChannelBundle;
class Packet;
 
class NullMessageMpiInterface : public ParallelCommunicationInterface, Object
{
  public:
    static TypeId GetTypeId();
 
    NullMessageMpiInterface();
    ~NullMessageMpiInterface() override;
 
    // Inherited
    void Destroy() override;
    uint32_t GetSystemId() override;
    uint32_t GetSize() override;
    bool IsEnabled() override;
    void Enable(int* pargc, char*** pargv) override;
    void Enable(MPI_Comm communicator) override;
    void Disable() override;
    void SendPacket(Ptr<Packet> p, const Time& rxTime, uint32_t node, uint32_t dev) override;
    MPI_Comm GetCommunicator() override;
 
  private:
    /*
     * The null message implementation is a collaboration of several
     * classes.  Methods that should be invoked only by the
     * collaborators are private to restrict use.
     * It is not intended for state to be shared.
     */
    friend ns3::RemoteChannelBundle;
    friend ns3::NullMessageSimulatorImpl;
 
    static void SendNullMessage(const Time& guaranteeUpdate, Ptr<RemoteChannelBundle> bundle);
    static void ReceiveMessagesNonBlocking();
    static void ReceiveMessagesBlocking();
    static void TestSendComplete();
 
    static void InitializeSendReceiveBuffers();
 
    static void ReceiveMessages(bool blocking = false);
 
    static uint32_t g_sid;
 
    static uint32_t g_size;
 
    static uint32_t g_numNeighbors;
 
    static bool g_enabled;
 
    static bool g_mpiInitCalled;
 
    static MPI_Request* g_requests;
 
    static char** g_pRxBuffers;
 
    static std::list<NullMessageSentBuffer> g_pendingTx;
 
    static MPI_Comm g_communicator;
 
    static bool g_freeCommunicator;
};
 
} // namespace ns3
 
#endif /* NS3_NULL_MESSAGE_MPI_INTERFACE_H */