null-message-mpi-interface.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 *  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/nstime.h>
#include <ns3/buffer.h>

#ifdef NS3_MPI
#include "mpi.h"
#else
typedef void* MPI_Request;
#endif

#include <list>

namespace ns3 {

class RemoteChannelBundle;
class Packet;

class NullMessageSentBuffer
{
public:
  NullMessageSentBuffer ();
  ~NullMessageSentBuffer ();

  uint8_t* GetBuffer ();
  void SetBuffer (uint8_t* buffer);
  MPI_Request* GetRequest ();

private:

  uint8_t* m_buffer;

  MPI_Request m_request;
};

class NullMessageMpiInterface : public ParallelCommunicationInterface
{
public:

  NullMessageMpiInterface ();
  ~NullMessageMpiInterface ();

  virtual void Destroy ();
  virtual uint32_t GetSystemId ();
  virtual uint32_t GetSize ();
  virtual bool IsEnabled ();
  virtual void Enable (int* pargc, char*** pargv);
  virtual void Disable ();
  virtual void SendPacket (Ptr<Packet> p, const Time &rxTime, uint32_t node, uint32_t dev);
  static void SendNullMessage (const Time& guaranteeUpdate, Ptr<RemoteChannelBundle> bundle);
  static void ReceiveMessagesNonBlocking ();
  static void ReceiveMessagesBlocking ();
  static void TestSendComplete ();

  static void InitializeSendReceiveBuffers (void);

private:

  static void ReceiveMessages (bool blocking = false);

  // System ID (rank) for this task
  static uint32_t g_sid;

  // Size of the MPI COM_WORLD group.
  static uint32_t g_size;

  // Number of neighbor tasks, tasks that this task shares a link with.
  static uint32_t g_numNeighbors;

  static bool     g_initialized;
  static bool     g_enabled;

  // Pending non-blocking receives
  static MPI_Request* g_requests;

  // Data buffers for non-blocking receives
  static char**   g_pRxBuffers;

  // List of pending non-blocking sends
  static std::list<NullMessageSentBuffer> g_pendingTx;
};

} // namespace ns3

#endif /* NS3_NULL_MESSAGE_MPI_INTERFACE_H */