Provided by: libsc-doc_2.3.1-22build2_all 
NAME
sc::ARMCIMemoryGrp - The ARMCIMemoryGrp concrete class provides an implementation of
MsgMemoryGrp.
SYNOPSIS
#include <memarmci.h>
Inherits sc::RDMAMemoryGrp.
Public Member Functions
ARMCIMemoryGrp (const Ref< MessageGrp > &msg)
ARMCIMemoryGrp (const Ref< KeyVal > &)
void set_localsize (size_t)
Set the size of locally held memory.
void retrieve_data (void *, int node, int offset, int size, int lock)
void replace_data (void *, int node, int offset, int size, int unlock)
void sum_data (double *data, int node, int doffset, int dsize)
void sync ()
Synchronizes all the nodes.
void deactivate ()
Deactivate is called after the memory has been used.
void * malloc_local (size_t nbyte)
Allocate data that will be accessed locally only.
void free_local (void *data)
Free data that was allocated with malloc_local_double.
void print (std::ostream &o=ExEnv::out0()) const
Prints out information about the object.
Public Member Functions inherited from sc::RDMAMemoryGrp
RDMAMemoryGrp (const Ref< MessageGrp > &msg)
RDMAMemoryGrp (const Ref< KeyVal > &)
void * localdata ()
Returns a pointer to the local data.
void set_localsize (size_t localsize)
Set the size of locally held memory.
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 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.
size_t localsize ()
Returns the amount of memory residing locally on me().
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 double * malloc_local_double (size_t ndouble)
virtual void free_local_double (double *data)
virtual void catchup ()
Processes outstanding requests.
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.
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.
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.
Protected Member Functions inherited from sc::RDMAMemoryGrp
void * malloc_region (size_t nbyte)
void free_region (void *)
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::RDMAMemoryGrp
char * data_
std::vector< Pool * > pools_
size_t default_pool_size_
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
The ARMCIMemoryGrp concrete class provides an implementation of MsgMemoryGrp.
It uses the ARMCI interface.
Member Function Documentation
void sc::ARMCIMemoryGrp::deactivate () [virtual]
Deactivate is called after the memory has been used.
Reimplemented from sc::MemoryGrp.
void sc::ARMCIMemoryGrp::free_local (void * data) [virtual]
Free data that was allocated with malloc_local_double.
Reimplemented from sc::MemoryGrp.
void * sc::ARMCIMemoryGrp::malloc_local (size_t nbyte) [virtual]
Allocate data that will be accessed locally only. Using this for data that will be used
for global operation can improve efficiency. Data allocated in this way must be freed with
free_local_double.
Reimplemented from sc::MemoryGrp.
void sc::ARMCIMemoryGrp::print (std::ostream & o = ExEnv::out0()) const [virtual]
Prints out information about the object.
Reimplemented from sc::MemoryGrp.
void sc::ARMCIMemoryGrp::replace_data (void *, int node, int offset, int size, int unlock)
[virtual]
Implements sc::RDMAMemoryGrp.
void sc::ARMCIMemoryGrp::retrieve_data (void *, int node, int offset, int size, int lock)
[virtual]
Implements sc::RDMAMemoryGrp.
void sc::ARMCIMemoryGrp::set_localsize (size_t) [virtual]
Set the size of locally held memory. When memory is accessed using a global offset
counting starts at node 0 and proceeds up to node n() - 1.
Implements sc::MemoryGrp.
void sc::ARMCIMemoryGrp::sum_data (double * data, int node, int doffset, int dsize) [virtual]
Implements sc::RDMAMemoryGrp.
void sc::ARMCIMemoryGrp::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.
Implements sc::MemoryGrp.
Author
Generated automatically by Doxygen for MPQC from the source code.