cps::MPISCU Namespace Reference
[Communications objects and functions]

Namespace for the MPI emulations of the SCU. More...

Functions
void	set_pe_grid (int x, int y, int z, int t, int s=1)
	Communicates the processor grid dimensions to the MPI-SCU layer.
void	CommsInit ()
	Initialises the MPI communications layer.
void	CommsFinalize ()
	Performs a clean exit from the MPI communications layer.
void	GlobalSum (Type_tag t, size_t tsize, int n, void *ivec, void *ovec)
	Computes a global sum directly using MPI.
void	RaiseError (char *errstr)
	Reports an error.
void	RaiseError (const char *errstring)
	Reports an error.
void	Trans (void *addr, MPI_Datatype mpi_dt, SCUDir dir, SCUXR sendrx)
	An implementation-specific internal subroutine.
void	ParseCommsParam (char *)
	An implementation-specific internal subroutine.
char *	CommsStringTokenizer (char *str, const char *tokens, char **tok_pos)
	An implementation-specific internal subroutine.
MPI_Datatype	MPITypeConv (Type_tag t, size_t tsize)
	An implementation-specific internal subroutine.
unsigned int	ReadSeedFile ()
	An implementation-specific internal subroutine.
int	printf (const char *format,...)
	Reimplementation of printf that prints from only a single node.
int	fprintf (FILE *stream, const char *format,...)
	Reimplementation of fprintf that prints from only a single node.
int	printf_all (const char *format,...)
	Reimplementation of printf that prints on all nodes.
int	printf_allid (const char *format,...)
	Reimplementation of printf that prints on all nodes with node ID prefix.
int	fprintf_all (FILE *stream, const char *format,...)
	Reimplementation of fprintf that prints on all nodes.
int	vprintf (const char *, va_list)
	Reimplementation of vprintf that prints from only a single node.
int	vfprintf (FILE *, const char *, va_list)
	Reimplementation of vfprintf that prints from only a single node.
void	SCUCommsFinalize (void)
void	SCUGlobalSum (Type_tag t, size_t tsize, int n, void *ivec, void *ovec)
Variables
bool	Is_Initialised = false
	Whether the MPI-SCU layer has been initialised.

---

Detailed Description

Namespace for the MPI emulations of the SCU.

---

Function Documentation

void CommsFinalize (   )

Performs a clean exit from the MPI communications layer.

char * cps::MPISCU::CommsStringTokenizer (  char *  str, const char *  delim, char **  tok_pos )

An implementation-specific internal subroutine. String tokenizer, coded here to ensure portability: Definition at line 816 of file sysfunc.C. Referenced by ParseCommsParam().

int cps::MPISCU::fprintf (  FILE *  stream, const char *  format,   ... )

Reimplementation of fprintf that prints from only a single node. Works like fprintf. Parameters: stream  The file handle to which to print format  The format string ...  Optional arguments to the format string Definition at line 59 of file qcdio_qprintf.C. References cps::UniqueID(). Referenced by PT::asqtad_fat(), cps::dump_xml::close(), cps::Lattice::CompareGaugeField(), wfm::dslash(), cps::dump_xml::dump_xml(), cps::Fopen(), PT::init(), wfm::init(), PT::init_g(), cps::GlobalJobParameter::InitMdwfTuning(), AsqD::InvCg(), AsqD::MdagM(), cps::CheckSum::Print(), cps::VML::Puts(), cps::GaussianRandomGenerator::Rand(), SCUGlobalSum(), cps::vml_enum(), cps::vml_enum_string(), cps::vml_enum_val(), and cps::dump_xml::write().

int cps::MPISCU::fprintf_all (  FILE *  stream, const char *  format,   ... )

Reimplementation of fprintf that prints on all nodes. Works just like fprintf. Parameters: stream  The file handle to which to print format  The format string ...  Optional arguments to the format string Definition at line 124 of file qcdio_qprintf.C. Referenced by CommsInit(), ReadSeedFile(), and cps::SCUTransComplete().

void GlobalSum (  Type_tag  t, size_t  tsize, int  n, void *  ivec, void *  ovec )

Computes a global sum directly using MPI.

MPI_Datatype cps::MPISCU::MPITypeConv (  Type_tag  t, size_t  tsize )

An implementation-specific internal subroutine. On-the-fly type+size -> MPI_Datatype conversion. There are probably somewhat quicker ways of doing this via look-up tables, but for now, the look-up has been left explicit. Definition at line 876 of file sysfunc.C. References RaiseError(), and cps::TYPE_IFloat. Referenced by SCUGlobalSum().

void cps::MPISCU::ParseCommsParam (  char *  envvar  )

An implementation-specific internal subroutine. Looks up and parses the run-time user parameters specified via ENVVAR. i.e. Lots of messy string handling et cetera. Todo: Currently, all PEs open the file and look up the required information. It would perhaps be quicker to get one PE to look in the file and then distribute the information. In fact, if only one node is capable of I/O, this would be neccessary, so it should be done. Definition at line 706 of file sysfunc.C. References CommsStringTokenizer(), cps::Fclose(), cps::Fopen(), and RaiseError(). Referenced by CommsInit().

int cps::MPISCU::printf (  const char *  format,   ... )

Reimplementation of printf that prints from only a single node. Works like printf. Parameters: format  The format string ...  Optional arguments to the format string Definition at line 40 of file qcdio_qprintf.C. References cps::UniqueID(). Referenced by cps::MPIRequestManager::AddRequest(), PT::Alloc(), AsqD::Alloc(), asq_print_flops(), PT::asqtad_long(), cps::WspectQuark::CheckSU3(), cps::Verbose::Clock(), cmm_agg_cpp(), cmv_agg_cpp(), cps::WspectExtendedMesons::collect(), cps::WspectExtendedMesonsBE::collect(), wfm::comm_complete(), wfm::comm_init(), wfm::comm_start(), cps::compare_array_relative(), cps::compare_float_relative(), wfm::CoreCount(), cross_over_lin_cpp(), cross_over_look_cpp(), wfm::decom(), AsqD::dirac(), dirac_cmm_jcw_agg_cpp(), dirac_cmv_jcw_agg_cpp(), cps::dirac_cmv_jcw_agg_cpp(), cps::DiracOpStag::DiracOpStag(), cps::WspectQuark::doSinkOperator(), wfm::dslash(), AsqD::Dslash(), cps::WspectMomenta::dumpData(), cps::WspectMesons::Everything(), cps::Fp4::EvolveMomFforce(), PT::FastAlloc(), cps::Fmdwf::FeigSolv(), cps::FdwfBase::FeigSolv(), cps::FermionVector::FermionVector(), cps::Error::FileA(), cps::Error::FileR(), cps::Error::FileW(), cps::WspectExtendedMesons::finish(), cps::WspectExtendedMesonsBE::finish(), cps::Verbose::Flow(), cps::Fstag::FmatEvlInv(), cps::FdwfBase::FsiteOffsetChkb(), cps::Verbose::Func(), cps::Verbose::FuncEnd(), cps::FermionVector::gaugeFixSink(), cps::FermionVectorTp::GaussianSmearVector(), cps::Error::General(), cps::getData(), cps::glb_sum_gimp(), cps::glb_sum_internal(), cps::Lattice::GsoCheck(), cps::Error::Hardware(), cps::Gsum64Ext::Init(), cps::wfm::init(), wfm::init(), AsqD::init(), AsqD::init_g(), cps::WspectExtendedMesons::initWMesonStateTable(), cps::Verbose::Input(), cps::Nuc3ptStru::InsertOp(), AsqD::InvCg(), cps::DiracOp::InvCgShift(), cps::Verbose::LedFlash(), cps::Verbose::LedOff(), cps::Verbose::LedOn(), cps::ParallelIO::load(), cps::DiracOpClover::MatEvlInv(), cps::MatHermElements(), cps::DiracOpWilson::MatInv(), cps::DiracOpP4::MatInv(), cps::DiracOpDwf::MatInv(), cps::DiracOpP4::MatPcDagMatPc(), cps::DiracOpAsqtad::MatPcDagMatPc(), cps::DiracOpClover::MatPcDagOrNot(), cps::wfm::mdag(), AsqD::MdagM(), cps::AlgGheatBath::NoCheckerBoardRun(), cps::AlgGheatBath::NodeCheckerBoardRun(), cps::Error::NotImplemented(), cps::p(), cps::Verbose::Pclear(), cps::Error::Pointer(), PT::PointerErr(), AsqD::PointerErr(), cps::Vector::Print(), cps::WspectMesons::print(), cps::WspectExtendedMesons::print(), cps::WspectExtendedMesonsBE::print(), cps::print_flops(), PT::print_flops(), cps::print_list(), cps::print_time(), cps::Matrix::ProjSU3(), pt_cmm_agg_print(), pt_cmv_cpp(), cps::qio_init::qio_init(), cps::qload_parameters(), cps::RandomGenerator::Rand(), cps::Lattice::RandGaussVector(), cps::ReadLatticeParallel::read(), wfm::recon(), cps::report_flops(), cps::Verbose::RNGSeed(), cps::WspectFuzzing::run(), cps::AlgWspect::run(), cps::AlgWspectExtMeson::run(), cps::AlgThreePt::run(), cps::AlgOlegSmear::run(), cps::AlgPot::run(), cps::AlgPbp::run(), cps::AlgOverRelax::run(), cps::AlgHmc::run(), cps::AlgHQPotential::run(), cps::AlgHmcQPQ::run(), cps::AlgHmcPhi::run(), cps::AlgGheatBath::run(), cps::AlgDens::run(), cps::Verbose::Sclear(), cps::FdwfBase::SetPhi(), cps::Fp4::Smear(), cps::Fasqtad::Smear(), cps::staggered_local_pion(), cps::Start(), cps::SerialIO::store(), cps::ParallelIO::store(), wfm::thread_create(), cps::FPConv::ti2ieee(), ti2ieee(), PT::update_momenta(), cps::Verbose::Warn(), cps::wfm_scope_assert(), wfm_scope_assert(), cps::wfm_scope_check(), wfm_scope_check(), cps::wilson_dslash(), wilson_dslash_blk_dag1(), cps::wilson_dslash_vec(), cps::LatRngWrite::write(), cps::WriteLatticeParallel::write(), cps::WspectFuzzing::WspectFuzzing(), cps::WspectQuark::WspectQuark(), cps::LinkBuffer::~LinkBuffer(), cps::qio_init::~qio_init(), cps::qio_readLattice::~qio_readLattice(), cps::qio_readPropagator::~qio_readPropagator(), cps::qio_writeLattice::~qio_writeLattice(), and cps::qio_writePropagator::~qio_writePropagator().

int cps::MPISCU::printf_all (  const char *  format,   ... )

Reimplementation of printf that prints on all nodes. Works just like printf. Parameters: format  The format string ...  Optional arguments to the format string Definition at line 77 of file qcdio_qprintf.C. Referenced by CommsInit().

int cps::MPISCU::printf_allid (  const char *  format,   ... )

Reimplementation of printf that prints on all nodes with node ID prefix. Works like printf, but prefixes the message with the node ID number and the cartesian coordinates of the node in the node grid. Parameters: format  The format string ...  Optional arguments to the format string Definition at line 94 of file qcdio_qprintf.C. References cps::GJP, cps::GlobalJobParameter::TnodeCoor(), cps::UniqueID(), cps::GlobalJobParameter::XnodeCoor(), cps::GlobalJobParameter::YnodeCoor(), and cps::GlobalJobParameter::ZnodeCoor().

unsigned int cps::MPISCU::ReadSeedFile (  void   )

An implementation-specific internal subroutine. Reads a seed for every PE from a file specified during intialisation. Definition at line 931 of file sysfunc.C. References CommsInit(), cps::Fclose(), cps::Fopen(), fprintf_all(), and RaiseError().

void cps::MPISCU::set_pe_grid (  int  x, int  y, int  z, int  t, int  s )

Communicates the processor grid dimensions to the MPI-SCU layer. If MPI is started outwith the MPI-SCU layer then this function should be used to tell the MPI-SCU layer what the grid dimensions are. This mechanism need and should not be used if the MPI parameters are read from a file. This function can only be called once; if it is called again it does nothing. Parameters: x  The grid dimension in the X direction. y  The grid dimension in the Y direction. z  The grid dimension in the Z direction. t  The grid dimension in the T direction. Definition at line 386 of file sysfunc.C.

void cps::MPISCU::Trans (  void *  addr, MPI_Datatype  mpi_dt, SCUDir  dir, SCUXR  sendrx )

An implementation-specific internal subroutine. The lowest level MPI comms subroutine, on which all other comms calls are based. Definition at line 661 of file sysfunc.C. References cps::MPIRequestManager::AddRequest(), and cps::dir. Referenced by cps::SCUTrans(), cps::SCUTransAddr(), and cps::Matrix::Trans().

int cps::MPISCU::vfprintf (  FILE *  f, const char *  format, va_list  arg )

Reimplementation of vfprintf that prints from only a single node. Works like vprintf. Parameters: format  The format string arg  The variable argument list. Definition at line 150 of file qcdio_qprintf.C. References cps::UniqueID(). Referenced by cps::Fprintf(), and cps::Vfprintf().

int cps::MPISCU::vprintf (  const char *  format, va_list  arg )

Reimplementation of vprintf that prints from only a single node. Works like vprintf. Parameters: format  The format string arg  The variable argument list. Definition at line 140 of file qcdio_qprintf.C. References cps::UniqueID(). Referenced by cps::Verbose::Debug(), cps::Error::General(), cps::Error::Hardware(), cps::Verbose::Input(), cps::Error::NotImplemented(), cps::Verbose::RNGSeed(), and cps::Verbose::Warn().

---

Variable Documentation

bool cps::MPISCU::Is_Initialised = false

Whether the MPI-SCU layer has been initialised. The initial value of the global comms-layer initialization flag is FALSE, indicating that the communications system has not been set up. Definition at line 52 of file sysfunc.C.

---