havoqgt::mpi::termination_detection< SizeType > Class Template Reference

#include <termination_detection.hpp>

Collaboration diagram for havoqgt::mpi::termination_detection< SizeType >:

Public Types
typedef SizeType	size_type
typedef std::pair< size_type, size_type >	status_response_type

Public Member Functions
	termination_detection (MPI_Comm in_mpi_comm, int in_num_tree_children=2, int in_query_status_tag=2, int in_query_response_tag=3, int in_terminate_tag=4)
void	inc_queued (size_t _i=1)
void	inc_completed (size_t _i=1)
bool	test_for_termination ()

Private Types
enum	termination_detection_state_type { WAITING_INIT, WAITING_ISEND_CHILDREN, WAITING_RECV_CHILDREN, WAITING_ISEND_PARENT }

Private Member Functions
bool	test_for_termination_internal (const size_type &in_queued, const size_type &in_completed)
bool	handle_waiting_init (const size_type &in_queued, const size_type &in_completed)
bool	handle_waiting_isend_children (const size_type &in_queued, const size_type &in_completed)
bool	handle_waiting_recv_children (const size_type &in_queued, const size_type &in_completed)
bool	handle_waiting_isend_parent (const size_type &in_queued, const size_type &in_completed)
void	send_terminate_to_children ()
bool	mpi_test (MPI_Request &in_req)
void	isend_status_response_to_parent ()
bool	mpi_iprobe (int in_source, int in_tag)
void	send_query_status_to_children ()
int	parent_rank ()
int	begin_child_rank ()
bool	is_leaf_rank ()
int	num_children ()

Private Attributes
MPI_Comm	m_mpi_comm
	Configuration parameters. More...
int	m_num_tree_children
int	m_query_status_tag
int	m_query_response_tag
int	m_terminate_tag
int	m_mpi_size
int	m_mpi_rank
termination_detection_state_type	m_current_state
std::vector< MPI_Request >	m_vec_req_isend_children
MPI_Request	m_req_isend_parent
status_response_type *	m_ptr_buf_isend_parent
int	m_num_waiting_recv_children
status_response_type	m_subtree_status_response
status_response_type	m_previous_subtree_status_response
size_type	m_count_queued
size_type	m_count_completed

Detailed Description

template<typename SizeType>
class havoqgt::mpi::termination_detection< SizeType >

Definition at line 97 of file termination_detection.hpp.

Member Typedef Documentation

template<typename SizeType>

typedef SizeType havoqgt::mpi::termination_detection< SizeType >::size_type

Definition at line 102 of file termination_detection.hpp.

template<typename SizeType>

typedef std::pair<size_type, size_type> havoqgt::mpi::termination_detection< SizeType >::status_response_type

Definition at line 103 of file termination_detection.hpp.

Member Enumeration Documentation

template<typename SizeType>

enum havoqgt::mpi::termination_detection::termination_detection_state_type

private

Enumerator
WAITING_INIT
WAITING_ISEND_CHILDREN
WAITING_RECV_CHILDREN
WAITING_ISEND_PARENT

Definition at line 99 of file termination_detection.hpp.

               {WAITING_INIT, WAITING_ISEND_CHILDREN, WAITING_RECV_CHILDREN,
        WAITING_ISEND_PARENT} termination_detection_state_type;

Constructor & Destructor Documentation

template<typename SizeType>

havoqgt::mpi::termination_detection< SizeType >::termination_detection ( MPI_Comm  in_mpi_comm, int  in_num_tree_children = 2, int  in_query_status_tag = 2, int  in_query_response_tag = 3, int  in_terminate_tag = 4  )

inline

Definition at line 105 of file termination_detection.hpp.

                                                                  {
    m_mpi_comm = in_mpi_comm;
    m_num_tree_children = in_num_tree_children;
    m_query_status_tag = in_query_status_tag;
    m_query_response_tag = in_query_response_tag;
    m_terminate_tag = in_terminate_tag;
    CHK_MPI( MPI_Comm_rank( m_mpi_comm, &m_mpi_rank) );
    CHK_MPI( MPI_Comm_size( m_mpi_comm, &m_mpi_size) );
    m_num_waiting_recv_children = num_children();
    m_subtree_status_response = status_response_type(0,0);
    m_current_state = WAITING_INIT;
    m_previous_subtree_status_response = 
            status_response_type(std::numeric_limits<size_type>::max(),
                                 std::numeric_limits<size_type>::max());

    m_count_queued = 0;
    m_count_completed = 0;
    /*for(int i=0; i<m_mpi_size; ++i) {
      if(m_mpi_rank == i) {
    std::cout << m_mpi_rank << " parent_rank() = " << parent_rank() << std::endl;
    std::cout << m_mpi_rank << " begin_child_rank() = " << begin_child_rank() << std::endl;
    std::cout << m_mpi_rank << " is_leaf_rank() = " << is_leaf_rank() << std::endl;
    std::cout << m_mpi_rank << " num_children() = " << num_children() << std::endl;   
    std::cout << std::endl;
    }
    MPI_Barrier(in_mpi_comm);

    }
    exit(-1);*/
  }

Member Function Documentation

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::begin_child_rank ( )

inlineprivate

Definition at line 303 of file termination_detection.hpp.

{ return (m_mpi_rank * m_num_tree_children)+1; }

Here is the caller graph for this function:

template<typename SizeType>

bool havoqgt::mpi::termination_detection< SizeType >::handle_waiting_init ( const size_type &  in_queued, const size_type &  in_completed  )

inlineprivate

Definition at line 163 of file termination_detection.hpp.

                                                          {
    //std::cout << m_mpi_rank << " " << __FUNCTION__ << std::endl;
    m_subtree_status_response.first = 0;
    m_subtree_status_response.second = 0;
    if(m_mpi_rank == 0) {
      send_query_status_to_children();
      m_current_state = WAITING_ISEND_CHILDREN;      
    } else {
      if(mpi_iprobe(parent_rank(), m_terminate_tag)) {
        CHK_MPI( MPI_Recv(NULL, 0, MPI_BYTE, parent_rank(), m_terminate_tag, m_mpi_comm, MPI_STATUS_IGNORE) );
        send_terminate_to_children();
        m_current_state = WAITING_INIT;
        return true;
      }
      else if(mpi_iprobe(/*parent_rank()*/MPI_ANY_SOURCE, m_query_status_tag)) {
        //std::cout << m_mpi_rank << "ReceivedInit" << std::endl;
        CHK_MPI( MPI_Recv(NULL, 0, MPI_BYTE, parent_rank(), m_query_status_tag,
                          m_mpi_comm, MPI_STATUS_IGNORE) );
        send_query_status_to_children();
        m_current_state = WAITING_ISEND_CHILDREN;
      } 
    }
    return false;
  }

Here is the caller graph for this function:

template<typename SizeType>

bool havoqgt::mpi::termination_detection< SizeType >::handle_waiting_isend_children ( const size_type &  in_queued, const size_type &  in_completed  )

inlineprivate

Definition at line 189 of file termination_detection.hpp.

                                                                     {
    //std::cout << m_mpi_rank << " " << __FUNCTION__ << std::endl;
    while(!m_vec_req_isend_children.empty()) {
      if(mpi_test(m_vec_req_isend_children.back())) 
       m_vec_req_isend_children.pop_back();
      else 
        break;
    }
    if(m_vec_req_isend_children.empty()) 
      m_current_state = WAITING_RECV_CHILDREN;
    return false;
  }

Here is the caller graph for this function:

template<typename SizeType>

bool havoqgt::mpi::termination_detection< SizeType >::handle_waiting_isend_parent ( const size_type &  in_queued, const size_type &  in_completed  )

inlineprivate

Definition at line 250 of file termination_detection.hpp.

                                                                   {
    //std::cout << m_mpi_rank << " " << __FUNCTION__ << std::endl;
    if(mpi_test(m_req_isend_parent)) {
      m_current_state = WAITING_INIT;
    }
    return false;
  }

Here is the caller graph for this function:

template<typename SizeType>

bool havoqgt::mpi::termination_detection< SizeType >::handle_waiting_recv_children ( const size_type &  in_queued, const size_type &  in_completed  )

inlineprivate

Definition at line 203 of file termination_detection.hpp.

                                                                    {
    //std::cout << m_mpi_rank << " " << __FUNCTION__ << std::endl;
    if(is_leaf_rank()) {
      m_subtree_status_response.first += in_queued;
      m_subtree_status_response.second += in_completed;
      isend_status_response_to_parent();
      m_current_state = WAITING_ISEND_PARENT;
    } else {
      status_response_type recv_buf;
      while(mpi_iprobe(MPI_ANY_SOURCE, m_query_response_tag)) {
        --m_num_waiting_recv_children;
        CHK_MPI( MPI_Recv( (void*) &recv_buf, sizeof(status_response_type), 
                           MPI_BYTE, MPI_ANY_SOURCE, m_query_response_tag, 
                           m_mpi_comm, MPI_STATUS_IGNORE) );
        m_subtree_status_response.first += recv_buf.first;
        m_subtree_status_response.second += recv_buf.second;
      }
      if(m_num_waiting_recv_children == 0) {
        m_num_waiting_recv_children = num_children();
        m_subtree_status_response.first += in_queued;
        m_subtree_status_response.second += in_completed;
        if(m_mpi_rank == 0) {
          if(m_subtree_status_response.first == m_subtree_status_response.second) {
            if(m_subtree_status_response == m_previous_subtree_status_response) {
              send_terminate_to_children();
              m_current_state = WAITING_INIT;
             return true;
            } else {
              m_previous_subtree_status_response = m_subtree_status_response;
            }
          } else {
            // This is a place we can debug termination detection
            //std::cout << "m_subtree_status_response = " << m_subtree_status_response.first
            //          << ", " << m_subtree_status_response.second << std::endl;
          }
          m_current_state = WAITING_INIT;
          return false;
        } else {
          isend_status_response_to_parent();
          m_current_state = WAITING_ISEND_PARENT;
        }
      }
    }
    return false;
  }

Here is the caller graph for this function:

template<typename SizeType>

void havoqgt::mpi::termination_detection< SizeType >::inc_completed ( size_t  _i = 1 )

inline

Definition at line 141 of file termination_detection.hpp.

{ m_count_completed += _i; }

Here is the caller graph for this function:

template<typename SizeType>

void havoqgt::mpi::termination_detection< SizeType >::inc_queued ( size_t  _i = 1 )

inline

Definition at line 140 of file termination_detection.hpp.

{ m_count_queued += _i; }

Here is the caller graph for this function:

template<typename SizeType>

bool havoqgt::mpi::termination_detection< SizeType >::is_leaf_rank ( )

inlineprivate

Definition at line 304 of file termination_detection.hpp.

{ return begin_child_rank() >= m_mpi_size; }

Here is the caller graph for this function:

template<typename SizeType>

void havoqgt::mpi::termination_detection< SizeType >::isend_status_response_to_parent ( )

inlineprivate

Definition at line 275 of file termination_detection.hpp.

                                         {
    //std::cout << m_mpi_rank << " " << __FUNCTION__ << std::endl;
    CHK_MPI( MPI_Isend( (void*) &m_subtree_status_response, sizeof(status_response_type),
                        MPI_BYTE, parent_rank(), m_query_response_tag,
                        m_mpi_comm, &m_req_isend_parent) );
  }

Here is the caller graph for this function:

template<typename SizeType>

bool havoqgt::mpi::termination_detection< SizeType >::mpi_iprobe ( int  in_source, int  in_tag  )

inlineprivate

Definition at line 282 of file termination_detection.hpp.

                                             {
    //std::cout << m_mpi_rank << " " << __FUNCTION__ << " source = " << in_source << " tag = " << in_tag << std::endl;
    MPI_Status status;
    int flag(0);
    CHK_MPI( MPI_Iprobe(in_source, in_tag, m_mpi_comm, &flag, &status) );
    return flag == 1;
  }

Here is the caller graph for this function:

template<typename SizeType>

bool havoqgt::mpi::termination_detection< SizeType >::mpi_test ( MPI_Request &  in_req )

inlineprivate

Definition at line 268 of file termination_detection.hpp.

                                     {
    //std::cout << m_mpi_rank << " " << __FUNCTION__ << std::endl;
    int flag(0);
    CHK_MPI( MPI_Test( &(in_req), &flag, MPI_STATUS_IGNORE) );
    return flag == 1;
  }

Here is the caller graph for this function:

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::num_children ( )

inlineprivate

Definition at line 305 of file termination_detection.hpp.

                     {  
    int to_return = std::min(m_num_tree_children, m_mpi_size - begin_child_rank()); 
    if (to_return < 0) to_return = 0;
    return to_return;
  }

Here is the caller graph for this function:

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::parent_rank ( )

inlineprivate

Definition at line 302 of file termination_detection.hpp.

{ return (m_mpi_rank-1) / m_num_tree_children; }

Here is the caller graph for this function:

template<typename SizeType>

void havoqgt::mpi::termination_detection< SizeType >::send_query_status_to_children ( )

inlineprivate

Definition at line 290 of file termination_detection.hpp.

                                       {
    //std::cout << m_mpi_rank << " " << __FUNCTION__ << std::endl;
    for(int i=0; i<num_children(); ++i) {
      int child_rank = i + begin_child_rank();
      MPI_Request isend_request;
      //std::cout << m_mpi_rank << "MPI_Isend -- " << child_rank << " " << m_query_status_tag << std::endl;
      CHK_MPI( MPI_Isend(NULL, 0, MPI_BYTE, child_rank, m_query_status_tag,
                         m_mpi_comm, &isend_request) );
      m_vec_req_isend_children.push_back(isend_request);
    }
  }

Here is the caller graph for this function:

template<typename SizeType>

void havoqgt::mpi::termination_detection< SizeType >::send_terminate_to_children ( )

inlineprivate

Definition at line 259 of file termination_detection.hpp.

                                    {
    //std::cout << m_mpi_rank << " " << __FUNCTION__ << std::endl;
    for(int i=0; i<num_children(); ++i) {
      int child_rank = i + begin_child_rank();
      CHK_MPI( MPI_Send(NULL, 0, MPI_BYTE, child_rank, m_terminate_tag,
                         m_mpi_comm) );
    }
  }

Here is the caller graph for this function:

template<typename SizeType>

bool havoqgt::mpi::termination_detection< SizeType >::test_for_termination ( )

inline

Definition at line 143 of file termination_detection.hpp.

                              {
    return test_for_termination_internal(m_count_queued, m_count_completed);
  }

Here is the caller graph for this function:

template<typename SizeType>

bool havoqgt::mpi::termination_detection< SizeType >::test_for_termination_internal ( const size_type &  in_queued, const size_type &  in_completed  )

inlineprivate

Definition at line 148 of file termination_detection.hpp.

                                                                    {
    switch(m_current_state) {
      case WAITING_INIT:
        return handle_waiting_init(in_queued, in_completed);
      case WAITING_ISEND_CHILDREN:
        return handle_waiting_isend_children(in_queued, in_completed);
      case WAITING_RECV_CHILDREN:
        return handle_waiting_recv_children(in_queued, in_completed);
      case WAITING_ISEND_PARENT:
        return handle_waiting_isend_parent(in_queued, in_completed);
    };
    return false;
  }

Here is the caller graph for this function:

Member Data Documentation

template<typename SizeType>

size_type havoqgt::mpi::termination_detection< SizeType >::m_count_completed

private

Definition at line 333 of file termination_detection.hpp.

template<typename SizeType>

size_type havoqgt::mpi::termination_detection< SizeType >::m_count_queued

private

Definition at line 332 of file termination_detection.hpp.

template<typename SizeType>

termination_detection_state_type havoqgt::mpi::termination_detection< SizeType >::m_current_state

private

Definition at line 322 of file termination_detection.hpp.

template<typename SizeType>

MPI_Comm havoqgt::mpi::termination_detection< SizeType >::m_mpi_comm

private

Configuration parameters.

Definition at line 313 of file termination_detection.hpp.

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::m_mpi_rank

private

Definition at line 320 of file termination_detection.hpp.

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::m_mpi_size

private

Definition at line 319 of file termination_detection.hpp.

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::m_num_tree_children

private

Definition at line 314 of file termination_detection.hpp.

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::m_num_waiting_recv_children

private

Definition at line 328 of file termination_detection.hpp.

template<typename SizeType>

status_response_type havoqgt::mpi::termination_detection< SizeType >::m_previous_subtree_status_response

private

Definition at line 330 of file termination_detection.hpp.

template<typename SizeType>

status_response_type* havoqgt::mpi::termination_detection< SizeType >::m_ptr_buf_isend_parent

private

Definition at line 327 of file termination_detection.hpp.

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::m_query_response_tag

private

Definition at line 316 of file termination_detection.hpp.

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::m_query_status_tag

private

Definition at line 315 of file termination_detection.hpp.

template<typename SizeType>

MPI_Request havoqgt::mpi::termination_detection< SizeType >::m_req_isend_parent

private

Definition at line 326 of file termination_detection.hpp.

template<typename SizeType>

status_response_type havoqgt::mpi::termination_detection< SizeType >::m_subtree_status_response

private

Definition at line 329 of file termination_detection.hpp.

template<typename SizeType>

int havoqgt::mpi::termination_detection< SizeType >::m_terminate_tag

private

Definition at line 317 of file termination_detection.hpp.

template<typename SizeType>

std::vector<MPI_Request> havoqgt::mpi::termination_detection< SizeType >::m_vec_req_isend_children

private

Definition at line 324 of file termination_detection.hpp.

---

The documentation for this class was generated from the following file:

• include/havoqgt/termination_detection.hpp