sc_MTMPIMemoryGrp - Man Page

This MemoryGrp class requires a MT-safe MPI implementation.

Synopsis

#include <memmtmpi.h>

Inherits sc::ActiveMsgMemoryGrp.

Public Member Functions

MTMPIMemoryGrp (const Ref< MessageGrp > &msg, const Ref< ThreadGrp > &th, MPI_Comm comm=MPI_COMM_WORLD)
Construct a MTMPIMemoryGrp given a MessageGrp, ThreadGrp, and an MPI communicator.
MTMPIMemoryGrp (const Ref< KeyVal > &)
Construct a MTMPIMemoryGrp given a KeyVal input object.
void activate ()
Activate is called before the memory is to be used.
void deactivate ()
Deactivate is called after the memory has been used.
void sync ()
Synchronizes all the nodes.

Public Member Functions inherited from sc::ActiveMsgMemoryGrp
ActiveMsgMemoryGrp (const Ref< MessageGrp > &msg)
ActiveMsgMemoryGrp (const Ref< KeyVal > &)
void set_localsize (size_t)
Set the size of locally held memory.
void * localdata ()
Returns a pointer to the local data.
void * obtain_writeonly (distsize_t offset, int size)
This gives write access to the memory location. No locking is done.
void * obtain_readwrite (distsize_t offset, int size)
Only one thread can have an unreleased obtain_readwrite at a time.
void * obtain_readonly (distsize_t offset, int size)
This gives read access to the memory location. No locking is done.
void release_readonly (void *data, distsize_t offset, int size)
This is called when read access is no longer needed.
void release_writeonly (void *data, distsize_t offset, int size)
This is called when write access is no longer needed.
void release_readwrite (void *data, distsize_t offset, int size)
This is called when read/write access is no longer needed.
void sum_reduction (double *data, distsize_t doffset, int dsize)
void sum_reduction_on_node (double *data, size_t doffset, int dsize, int node=-1)
void print (std::ostream &o=ExEnv::out0()) const
Prints out information about the object.

Public Member Functions inherited from sc::MsgMemoryGrp
MsgMemoryGrp (const Ref< MessageGrp > &msg)
MsgMemoryGrp (const Ref< KeyVal > &keyval)
void set_localsize (size_t localsize)
Set the size of locally held memory.
void sync ()
Synchronizes all the nodes.

Public Member Functions inherited from sc::MemoryGrp
MemoryGrp (const Ref< KeyVal > &)
int me () const
Returns who I am.
int n () const
Returns how many nodes there are.
virtual void set_localsize (size_t)=0
Set the size of locally held memory.
size_t localsize ()
Returns the amount of memory residing locally on me().
virtual void * localdata ()=0
Returns a pointer to the local data.
distsize_t localoffset ()
Returns the global offset to this node's memory.
int size (int node)
Returns the amount of memory residing on node.
distsize_t offset (int node)
Returns the global offset to node's memory.
distsize_t totalsize ()
Returns the sum of all memory allocated on all nodes.
virtual void activate ()
Activate is called before the memory is to be used.
virtual void deactivate ()
Deactivate is called after the memory has been used.
virtual void * obtain_writeonly (distsize_t offset, int size)=0
This gives write access to the memory location. No locking is done.
virtual void * obtain_readwrite (distsize_t offset, int size)=0
Only one thread can have an unreleased obtain_readwrite at a time.
virtual void * obtain_readonly (distsize_t offset, int size)=0
This gives read access to the memory location. No locking is done.
virtual void release_readonly (void *data, distsize_t offset, int size)=0
This is called when read access is no longer needed.
virtual void release_writeonly (void *data, distsize_t offset, int size)=0
This is called when write access is no longer needed.
virtual void release_readwrite (void *data, distsize_t offset, int size)=0
This is called when read/write access is no longer needed.
virtual void sum_reduction (double *data, distsize_t doffset, int dsize)
virtual void sum_reduction_on_node (double *data, size_t doffset, int dsize, int node=-1)
virtual void sync ()=0
Synchronizes all the nodes.
virtual void * malloc_local (size_t nbyte)
Allocate data that will be accessed locally only.
virtual double * malloc_local_double (size_t ndouble)
virtual void free_local (void *data)
Free data that was allocated with malloc_local_double.
virtual void free_local_double (double *data)
virtual void catchup ()
Processes outstanding requests.
virtual void print (std::ostream &o=ExEnv::out0()) const
Prints out information about the object.

Public Member Functions inherited from sc::DescribedClass
DescribedClass (const DescribedClass &)
DescribedClass & operator= (const DescribedClass &)
ClassDesc * class_desc () const  throw ()
This returns the unique pointer to the ClassDesc corresponding to the given type_info object.
const char * class_name () const
Return the name of the object's exact type.
int class_version () const
Return the version of the class.
virtual void print (std::ostream &=ExEnv::out0()) const
Print the object.

Public Member Functions inherited from sc::RefCount
int lock_ptr () const
Lock this object.
int unlock_ptr () const
Unlock this object.
void use_locks (bool inVal)
start and stop using locks on this object
refcount_t nreference () const
Return the reference count.
refcount_t reference ()
Increment the reference count and return the new count.
refcount_t dereference ()
Decrement the reference count and return the new count.
int managed () const
void unmanage ()
Turn off the reference counting mechanism for this object.
int managed () const
Return 1 if the object is managed. Otherwise return 0.

Public Member Functions inherited from sc::Identity
Identifier identifier ()
Return the Identifier for this argument.

Friends

class MTMPIThread

Additional Inherited Members

Static Public Member Functions inherited from sc::MemoryGrp

static MemoryGrp * initial_memorygrp (int &argc, char **argv)
Create a memory group.
static MemoryGrp * initial_memorygrp ()
static void set_default_memorygrp (const Ref< MemoryGrp > &)
The default memory group contains the primary memory group to be used by an application.
static MemoryGrp * get_default_memorygrp ()
Returns the default memory group.
virtual void retrieve_data (void *, int node, int offset, int size, int lock)=0
virtual void replace_data (void *, int node, int offset, int size, int unlock)=0
virtual void sum_data (double *data, int node, int doffset, int dsize)=0

Protected Member Functions inherited from sc::MemoryGrp
void obtain_local_lock (size_t start, size_t fence)
void release_local_lock (size_t start, size_t fence)

Protected Member Functions inherited from sc::RefCount
RefCount (const RefCount &)
RefCount & operator= (const RefCount &)

Protected Attributes inherited from sc::ActiveMsgMemoryGrp
char * data_

Protected Attributes inherited from sc::MsgMemoryGrp
Ref< MessageGrp > msg_

Protected Attributes inherited from sc::MemoryGrp
int me_
int n_
distsize_t * offsets_
int debug_

Detailed Description

This MemoryGrp class requires a MT-safe MPI implementation.

The default MessageGrp must be a MPIMessageGrp. MPI must be safe with respect to the default ThreadGrp. Alternately, a MessageGrp and a ThreadGrp can be passed to the constructor.

Constructor & Destructor Documentation

sc::MTMPIMemoryGrp::MTMPIMemoryGrp (const Ref< MessageGrp > & msg, const Ref< ThreadGrp > & th, MPI_Comm comm = MPI_COMM_WORLD)

Construct a MTMPIMemoryGrp given a MessageGrp, ThreadGrp, and an MPI communicator. The communicator can be a subset of MPI_COMM_WORLD, in which case, the MessageGrp must refer to the same subset.

sc::MTMPIMemoryGrp::MTMPIMemoryGrp (const Ref< KeyVal > &)

Construct a MTMPIMemoryGrp given a KeyVal input object. A fully thread safe MPI is needed (MPI_THREAD_MULTIPLE).

Member Function Documentation

void sc::MTMPIMemoryGrp::activate () [virtual]

Activate is called before the memory is to be used.

Reimplemented from sc::MemoryGrp.

void sc::MTMPIMemoryGrp::deactivate () [virtual]

Deactivate is called after the memory has been used.

Reimplemented from sc::MemoryGrp.

void sc::MTMPIMemoryGrp::sync () [virtual]

Synchronizes all the nodes. This is useful after remote memory writes to be certain that all of the writes have completed and the data can be accessed locally, for example.

Reimplemented from sc::MsgMemoryGrp.

Author

Generated automatically by Doxygen for MPQC from the source code.

Info

Thu Jan 19 2023 Version 2.3.1 MPQC