#include <MPI_WorkUnitManager.hh>

Inheritance diagram for protocols::wum::MPI_WorkUnitManager:

Public Member Functions
	MPI_WorkUnitManager (char machine_letter)

	~MPI_WorkUnitManager () override=default

void	go () override=0

Public Member Functions inherited from protocols::wum::WorkUnitManager
	WorkUnitManager ()

	~WorkUnitManager () override=default

void	register_work_units (const protocols::wum::WorkUnitList &work_unit_list)

WorkUnitQueue &	outbound ()

WorkUnitQueue &	inbound ()

const WorkUnitQueue &	outbound () const

const WorkUnitQueue &	inbound () const

Protected Types
enum	MPI_TIMING { TIMING_WAIT =0, TIMING_TRANSFER_SEND, TIMING_TRANSFER_RECV, TIMING_CPU, TIMING_IO_WRITE, TIMING_IO_READ, TIMING_IDLE, TIMING_end }

Protected Member Functions
virtual void	init ()=0

virtual void	process_inbound_wus ()=0

virtual void	process_outbound_wus ()=0

virtual void	print_stats ()
	Print a line with general run statistics, now. More...

virtual void	print_stats_auto ()
	Print a line with general run statistics, only if enough time has pased since the last statistics printout. More...

void	reset_timing_stats ()
	Reset all the stats counters. More...

void	process_incoming_msgs (bool wait_until_message=false)
	MPI Communication function. More...

void	send_MPI_workunit (const WorkUnitBaseOP &wu, int dest_rank) const
	Send a workunit to an arbitrary recipient. More...

void	receive_MPI_workunit (core::Size node_rank=MPI_ANY_SOURCE)
	Receive a workunit and add it to the inbound queue. By default accept any workunit or accept a specific source rank. Note that this function is blocking and will onyl return once a workunit has been received. More...

void	send_next_WU_on_request ()

char	get_machine_letter ()
	How many masters are there in total ? More...

core::Real	start_timer (MPI_TIMING timing_mode) const
	This initiates a new timer block. Note that there is no end_timer() function - you just keep calling start_timer, which automatically ends the previous block (and records times etc) More...

void	print_timing_stats ()
	Display the timing statistics. More...

long	wall_time () const
	Return the total life time of this class in seconds. More...

Protected Member Functions inherited from protocols::wum::WorkUnitManager
const protocols::wum::WorkUnitList &	work_unit_list () const

protocols::wum::WorkUnitList &	work_unit_list ()

void	write_queues_to_file (const std::string &prefix="default") const

void	write_work_unit (const WorkUnitBaseOP &wu, std::ostream &out) const

void	write_queue (const WorkUnitQueue &the_queue, std::ostream &out) const

void	read_queues_from_file (const std::string &prefix="default")

bool	read_work_unit (WorkUnitBaseOP &qualified_wu, std::istream &in)

void	read_queue (WorkUnitQueue &the_queue, std::istream &in)

core::Size	mem_foot_print () const
	return total memory foot print in bytes More...

Private Attributes
core::Size	print_statw_interval_
	Minimum time in seconds between statistics updates (to screen) More...

core::Real	timing_last_start_time_
	when did the last timing block start ? (unixtime) More...

MPI_TIMING	timing_last_type_
	Timing type that is currently active. More...

core::Real	timing_total_ [TIMING_end]
	Running sums of total time spent in for any given timing type. More...

long	start_time_wall_clock_
	Start unixtime of this class (set once in contructor) More...

long	last_stats_
	Last unixtime when stats were printed. More...

core::Size	traffic_total_received_
	Total amount of traffic received, in bytes. More...

core::Size	traffic_total_sent_
	Total amount of traffic sent, in bytes. More...

core::Real	send_wu_time_
	Total time spent in MPI_Send. More...

core::Real	send_wu_time_n_
	Total number of sends. More...

core::Real	recv_wu_time_
	Total time spent in MPI_Recv. More...

core::Real	recv_wu_time_n_
	Total time of receives. More...

char	machine_letter_

Additional Inherited Members
Public Types inherited from protocols::wum::WorkUnitManager
typedef WorkUnitQueue::iterator	iterator

typedef WorkUnitQueue::const_iterator	const_iterator

Member Enumeration Documentation

enum protocols::wum::MPI_WorkUnitManager::MPI_TIMING

protected

Enumerator
TIMING_WAIT
TIMING_TRANSFER_SEND
TIMING_TRANSFER_RECV
TIMING_CPU
TIMING_IO_WRITE
TIMING_IO_READ
TIMING_IDLE
TIMING_end

Constructor & Destructor Documentation

protocols::wum::MPI_WorkUnitManager::MPI_WorkUnitManager ( char machine_letter )

References protocols::wum::WorkUnitManager::inbound(), protocols::wum::mpi_npes(), protocols::wum::mpi_rank(), protocols::wum::WorkUnitManager::outbound(), reset_timing_stats(), protocols::wum::WorkUnitQueue::set_memory_limit(), start_time_wall_clock_, start_timer(), TIMING_CPU, timing_last_start_time_, and timing_last_type_.

protocols::wum::MPI_WorkUnitManager::~MPI_WorkUnitManager ( )

overridedefault

Member Function Documentation

char protocols::wum::MPI_WorkUnitManager::get_machine_letter ( )

protected

How many masters are there in total ?

This is for masters only - returns a serial master number, i.e. 0 is the first master, N-1 is the last master. Returns the running serial number (0 based) of a master. Returns 0 if emperor The first master returns 0, the second returns 1, etc..

References machine_letter_.

Referenced by print_stats().

void protocols::wum::MPI_WorkUnitManager::go ( )

overridepure virtual

Implements protocols::wum::WorkUnitManager.

Implemented in protocols::loophash::MPI_LoopHashRefine_Emperor, protocols::mpi_refinement::MPI_Refine_Emperor, protocols::mpi_refinement::MPI_Refine_Master, protocols::loophash::MPI_LoopHashRefine_Master, and protocols::wum::MPI_WorkUnitManager_Slave.

virtual void protocols::wum::MPI_WorkUnitManager::init ( )

protectedpure virtual

Implemented in protocols::loophash::MPI_LoopHashRefine_Emperor, protocols::mpi_refinement::MPI_Refine_Emperor, protocols::mpi_refinement::MPI_Refine_Master, protocols::loophash::MPI_LoopHashRefine_Master, and protocols::wum::MPI_WorkUnitManager_Slave.

void protocols::wum::MPI_WorkUnitManager::print_stats ( )

protectedvirtual

void protocols::wum::MPI_WorkUnitManager::print_stats_auto ( )

protectedvirtual

Print a line with general run statistics, only if enough time has pased since the last statistics printout.

References last_stats_, and print_stats().

Referenced by protocols::wum::MPI_WorkUnitManager_Slave::go(), and process_incoming_msgs().

void protocols::wum::MPI_WorkUnitManager::print_timing_stats ( )

protected

Display the timing statistics.

virtual void protocols::wum::MPI_WorkUnitManager::process_inbound_wus ( )

protectedpure virtual

Implemented in protocols::loophash::MPI_LoopHashRefine_Emperor, protocols::mpi_refinement::MPI_Refine_Emperor, protocols::mpi_refinement::MPI_Refine_Master, protocols::loophash::MPI_LoopHashRefine_Master, and protocols::wum::MPI_WorkUnitManager_Slave.

void protocols::wum::MPI_WorkUnitManager::process_incoming_msgs ( bool wait_until_message = false )

protected

MPI Communication function.

Check for messages and process them accordingly

References MPI_ANY_SOURCE, protocols::wum::WorkUnitManager::outbound(), print_stats_auto(), receive_MPI_workunit(), send_next_WU_on_request(), protocols::wum::WorkUnitQueue::size(), start_timer(), TIMING_CPU, TIMING_IDLE, protocols::wum::WUM_MPI_REQUEST_WU, and protocols::wum::WUM_MPI_SEND_WU.

Referenced by protocols::wum::MPI_WorkUnitManager_Slave::go().

virtual void protocols::wum::MPI_WorkUnitManager::process_outbound_wus ( )

protectedpure virtual

Implemented in protocols::loophash::MPI_LoopHashRefine_Emperor, protocols::mpi_refinement::MPI_Refine_Emperor, protocols::mpi_refinement::MPI_Refine_Master, protocols::loophash::MPI_LoopHashRefine_Master, and protocols::wum::MPI_WorkUnitManager_Slave.

void protocols::wum::MPI_WorkUnitManager::receive_MPI_workunit ( core::Size node_rank = MPI_ANY_SOURCE )

protected

Receive a workunit and add it to the inbound queue. By default accept any workunit or accept a specific source rank. Note that this function is blocking and will onyl return once a workunit has been received.

References protocols::wum::WorkUnitQueue::add(), core::chemical::element::F, protocols::wum::get_time(), protocols::wum::WorkUnitList::get_work_unit(), protocols::wum::WorkUnitManager::inbound(), recv_wu_time_, recv_wu_time_n_, start_timer(), TIMING_CPU, TIMING_TRANSFER_RECV, traffic_total_received_, TRDEBUG, protocols::wum::WorkUnitManager::work_unit_list(), protocols::wum::WUM_MPI_DATA_BLOCK, and protocols::wum::WUM_MPI_SEND_WU.

Referenced by process_incoming_msgs().

void protocols::wum::MPI_WorkUnitManager::reset_timing_stats ( )

protected

Reset all the stats counters.

References timing_total_.

Referenced by MPI_WorkUnitManager(), and print_stats().

void protocols::wum::MPI_WorkUnitManager::send_MPI_workunit	(	const WorkUnitBaseOP &	wu,
		int	dest_rank
	)		const

protected

void protocols::wum::MPI_WorkUnitManager::send_next_WU_on_request ( )

protected

References protocols::wum::WorkUnitQueue::begin(), core::sequence::end, protocols::wum::WorkUnitQueue::end(), protocols::wum::WorkUnitQueue::erase(), MPI_ANY_SOURCE, protocols::wum::WorkUnitManager::outbound(), protocols::wum::WorkUnitQueue::push_back(), send_MPI_workunit(), protocols::wum::WorkUnitQueue::size(), start_timer(), TIMING_CPU, TRDEBUG, and protocols::wum::WUM_MPI_REQUEST_WU.

Referenced by process_incoming_msgs().

core::Real protocols::wum::MPI_WorkUnitManager::start_timer ( MPI_TIMING timing_mode ) const

protected

This initiates a new timer block. Note that there is no end_timer() function - you just keep calling start_timer, which automatically ends the previous block (and records times etc)

References protocols::wum::get_time(), TIMING_end, timing_last_start_time_, timing_last_type_, and timing_total_.

Referenced by protocols::loophash::MPI_LoopHashRefine::add_structure_to_library_add_n_replace(), protocols::mpi_refinement::MPI_Refinement::add_structure_to_library_add_n_replace(), protocols::loophash::MPI_LoopHashRefine::dump_structures(), protocols::mpi_refinement::MPI_Refinement::dump_structures(), protocols::loophash::MPI_LoopHashRefine::load_state(), protocols::mpi_refinement::MPI_Refinement::load_state(), protocols::loophash::MPI_LoopHashRefine::load_structures_from_cmdline_into_library(), protocols::mpi_refinement::MPI_Refinement::load_structures_from_cmdline_into_library(), MPI_WorkUnitManager(), protocols::wum::MPI_WorkUnitManager_Slave::process_inbound_wus(), process_incoming_msgs(), receive_MPI_workunit(), protocols::wum::MPI_WorkUnitManager_Slave::request_new_jobs(), protocols::loophash::MPI_LoopHashRefine::save_state(), protocols::mpi_refinement::MPI_Refinement::save_state(), send_MPI_workunit(), and send_next_WU_on_request().