granted-time-window-mpi-interface.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * 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: George Riley <riley@ece.gatech.edu>
 */

// This object contains static methods that provide an easy interface
// to the necessary MPI information.

#ifndef NS3_GRANTED_TIME_WINDOW_MPI_INTERFACE_H
#define NS3_GRANTED_TIME_WINDOW_MPI_INTERFACE_H

#include <stdint.h>
#include <list>

#include "ns3/nstime.h"
#include "ns3/buffer.h"

#include "parallel-communication-interface.h"

#include "mpi.h"

namespace ns3 {

const uint32_t MAX_MPI_MSG_SIZE = 2000;

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

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

private:
  uint8_t* m_buffer;      
  MPI_Request m_request;  
};

class Packet;
class DistributedSimulatorImpl;

class GrantedTimeWindowMpiInterface : public ParallelCommunicationInterface, Object
{
public:
  static TypeId GetTypeId (void);

  // Inherited
  virtual void Destroy ();
  virtual uint32_t GetSystemId ();
  virtual uint32_t GetSize ();
  virtual bool IsEnabled ();
  virtual void Enable (int* pargc, char*** pargv);
  virtual void Enable (MPI_Comm communicator);
  virtual void Disable();
  virtual void SendPacket (Ptr<Packet> p, const Time &rxTime, uint32_t node, uint32_t dev);
  virtual MPI_Comm GetCommunicator();

private:

  /*
   * The granted time window 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::DistributedSimulatorImpl;
  
  static void ReceiveMessages ();
  static void TestSendComplete ();
  static uint32_t GetRxCount ();
  static uint32_t GetTxCount ();
  
  static uint32_t g_sid;
  static uint32_t g_size;

  static uint32_t g_rxCount;

  static uint32_t g_txCount;

  static bool     g_enabled;

  static bool     g_mpiInitCalled;

  static MPI_Request* g_requests;

  static char**   g_pRxBuffers;

  static std::list<SentBuffer> g_pendingTx;

  static MPI_Comm g_communicator;

  static bool g_freeCommunicator;
};

} // namespace ns3

#endif /* NS3_GRANTED_TIME_WINDOW_MPI_INTERFACE_H */