logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

sc::ProcMemoryGrp - The ProcMemoryGrp concrete class provides an implementation of MemoryGrp for a single

Author

       Generated automatically by Doxygen for MPQC from the source code.

Version 2.3.1                                    Sun Oct 4 2020                             sc::ProcMemoryGrp(3)

Detailed Description

       The ProcMemoryGrp concrete class provides an implementation of MemoryGrp for a single processor.

Member Function Documentation

void*sc::ProcMemoryGrp::obtain_readwrite(distsize_toffset,intsize)[virtual]
       Only one thread can have an unreleased obtain_readwrite at a time. The actual memory region locked can be
       larger than that requested. If the memory region is already locked this will block. For this reason, data
       should be held as read/write for as short a time as possible.

       Implements sc::MemoryGrp.

   voidsc::ProcMemoryGrp::release_readwrite(void*data,distsize_toffset,intsize)[virtual]
       This is called when read/write access is no longer needed. The memory will be unlocked.

       Implements sc::MemoryGrp.

   voidsc::ProcMemoryGrp::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.

   voidsc::ProcMemoryGrp::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.

Name

       sc::ProcMemoryGrp - The ProcMemoryGrp concrete class provides an implementation of MemoryGrp for a single
       processor.

Synopsis

       #include <memproc.h>

       Inherits sc::MemoryGrp.

   PublicMemberFunctionsProcMemoryGrp (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_readwrite (distsize_toffset, int size)
           Only one thread can have an unreleased obtain_readwrite at a time.
       void * obtain_readonly (distsize_toffset, int size)
           This gives read access to the memory location. No locking is done.
       void * obtain_writeonly (distsize_toffset, int size)
           This gives write access to the memory location. No locking is done.
       void release_readonly (void *data, distsize_toffset, int size)
           This is called when read access is no longer needed.
       void release_writeonly (void *data, distsize_toffset, int size)
           This is called when write access is no longer needed.
       void release_readwrite (void *data, distsize_toffset, int size)
           This is called when read/write access is no longer needed.
       void sync ()
           Synchronizes all the nodes.

   AdditionalInheritedMembers

See Also