<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>MPQC: sc::MemoryGrp Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>sc</b>::<a class="el" href="classsc_1_1MemoryGrp.html">MemoryGrp</a>
</div>
</div>
<div class="contents">
<h1>sc::MemoryGrp Class Reference</h1><!-- doxytag: class="sc::MemoryGrp" --><!-- doxytag: inherits="sc::DescribedClass" -->The <a class="el" href="classsc_1_1MemoryGrp.html" title="The MemoryGrp abstract class provides a way of accessing distributed memory in a...">MemoryGrp</a> abstract class provides a way of accessing distributed memory in a parallel machine.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="memory_8h_source.html">memory.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for sc::MemoryGrp:</div>
<div class="dynsection">
<p><center><img src="classsc_1_1MemoryGrp.png" usemap="#sc::MemoryGrp_map" border="0" alt=""></center>
<map name="sc::MemoryGrp_map">
<area href="classsc_1_1DescribedClass.html" alt="sc::DescribedClass" shape="rect" coords="252,112,410,136">
<area href="classsc_1_1RefCount.html" alt="sc::RefCount" shape="rect" coords="252,56,410,80">
<area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="252,0,410,24">
<area href="classsc_1_1MsgMemoryGrp.html" alt="sc::MsgMemoryGrp" shape="rect" coords="168,224,326,248">
<area href="classsc_1_1ProcMemoryGrp.html" alt="sc::ProcMemoryGrp" shape="rect" coords="336,224,494,248">
<area href="classsc_1_1ActiveMsgMemoryGrp.html" alt="sc::ActiveMsgMemoryGrp" shape="rect" coords="0,280,158,304">
<area href="classsc_1_1RDMAMemoryGrp.html" alt="sc::RDMAMemoryGrp" shape="rect" coords="168,280,326,304">
<area href="classsc_1_1ShmMemoryGrp.html" alt="sc::ShmMemoryGrp" shape="rect" coords="336,280,494,304">
<area href="classsc_1_1MTMPIMemoryGrp.html" alt="sc::MTMPIMemoryGrp" shape="rect" coords="0,336,158,360">
<area href="classsc_1_1ARMCIMemoryGrp.html" alt="sc::ARMCIMemoryGrp" shape="rect" coords="168,336,326,360">
</map>
</div>
<p>
<a href="classsc_1_1MemoryGrp-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c173f8e0e4380b70c4c61e6b3d763c62"></a><!-- doxytag: member="sc::MemoryGrp::MemoryGrp" ref="c173f8e0e4380b70c4c61e6b3d763c62" args="(const Ref< KeyVal > &)" -->
</td><td class="memItemRight" valign="bottom"><b>MemoryGrp</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> > &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b61aa9431f137985c7cbfcf84e2b573e"></a><!-- doxytag: member="sc::MemoryGrp::me" ref="b61aa9431f137985c7cbfcf84e2b573e" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#b61aa9431f137985c7cbfcf84e2b573e">me</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns who I am. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2f204165147154bd15600ea8929b3c6"></a><!-- doxytag: member="sc::MemoryGrp::n" ref="a2f204165147154bd15600ea8929b3c6" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#a2f204165147154bd15600ea8929b3c6">n</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns how many nodes there are. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#4ee243438a21eb017e3f5f6624ab9cfc">set_localsize</a> (size_t)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the size of locally held memory. <a href="#4ee243438a21eb017e3f5f6624ab9cfc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e56426818b8a6d9b333e33ccdd23f32b"></a><!-- doxytag: member="sc::MemoryGrp::localsize" ref="e56426818b8a6d9b333e33ccdd23f32b" args="()" -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#e56426818b8a6d9b333e33ccdd23f32b">localsize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of memory residing locally on <a class="el" href="classsc_1_1MemoryGrp.html#b61aa9431f137985c7cbfcf84e2b573e" title="Returns who I am.">me()</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ddc2e145860610b03e2e2af5417e74c8"></a><!-- doxytag: member="sc::MemoryGrp::localdata" ref="ddc2e145860610b03e2e2af5417e74c8" args="()=0" -->
virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#ddc2e145860610b03e2e2af5417e74c8">localdata</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the local data. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ea2b088ce7904ec4cba6f40555a69833"></a><!-- doxytag: member="sc::MemoryGrp::localoffset" ref="ea2b088ce7904ec4cba6f40555a69833" args="()" -->
distsize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#ea2b088ce7904ec4cba6f40555a69833">localoffset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the global offset to this node's memory. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16856ef367eb8d9b39bb36525d7753bf"></a><!-- doxytag: member="sc::MemoryGrp::size" ref="16856ef367eb8d9b39bb36525d7753bf" args="(int node)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#16856ef367eb8d9b39bb36525d7753bf">size</a> (int node)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of memory residing on node. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c65ac54b76c98942de3dcae3bb776e03"></a><!-- doxytag: member="sc::MemoryGrp::offset" ref="c65ac54b76c98942de3dcae3bb776e03" args="(int node)" -->
distsize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#c65ac54b76c98942de3dcae3bb776e03">offset</a> (int node)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the global offset to node's memory. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70f900af5de88700224ed3cceecd1fc9"></a><!-- doxytag: member="sc::MemoryGrp::totalsize" ref="70f900af5de88700224ed3cceecd1fc9" args="()" -->
distsize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#70f900af5de88700224ed3cceecd1fc9">totalsize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the sum of all memory allocated on all nodes. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72903ddd45d1dd9deabb92970a81aec8"></a><!-- doxytag: member="sc::MemoryGrp::activate" ref="72903ddd45d1dd9deabb92970a81aec8" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#72903ddd45d1dd9deabb92970a81aec8">activate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activate is called before the memory is to be used. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee66fcdd210e3d4670d5e2e4ae9c0755"></a><!-- doxytag: member="sc::MemoryGrp::deactivate" ref="ee66fcdd210e3d4670d5e2e4ae9c0755" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#ee66fcdd210e3d4670d5e2e4ae9c0755">deactivate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deactivate is called after the memory has been used. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2724fd5ab40d08eb3a437c33a2ce8cd3"></a><!-- doxytag: member="sc::MemoryGrp::obtain_writeonly" ref="2724fd5ab40d08eb3a437c33a2ce8cd3" args="(distsize_t offset, int size)=0" -->
virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#2724fd5ab40d08eb3a437c33a2ce8cd3">obtain_writeonly</a> (distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This gives write access to the memory location. No locking is done. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#adba96c579589e6be4ce48bd275137a0">obtain_readwrite</a> (distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Only one thread can have an unreleased obtain_readwrite at a time. <a href="#adba96c579589e6be4ce48bd275137a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="024fecfeccb5aba14fa924c269f53004"></a><!-- doxytag: member="sc::MemoryGrp::obtain_readonly" ref="024fecfeccb5aba14fa924c269f53004" args="(distsize_t offset, int size)=0" -->
virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#024fecfeccb5aba14fa924c269f53004">obtain_readonly</a> (distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This gives read access to the memory location. No locking is done. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e89f53271232a10bd206dabf6445bad"></a><!-- doxytag: member="sc::MemoryGrp::release_readonly" ref="6e89f53271232a10bd206dabf6445bad" args="(void *data, distsize_t offset, int size)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#6e89f53271232a10bd206dabf6445bad">release_readonly</a> (void *data, distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is called when read access is no longer needed. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e2cd771d786240a0885f842a183f5f1"></a><!-- doxytag: member="sc::MemoryGrp::release_writeonly" ref="4e2cd771d786240a0885f842a183f5f1" args="(void *data, distsize_t offset, int size)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#4e2cd771d786240a0885f842a183f5f1">release_writeonly</a> (void *data, distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is called when write access is no longer needed. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#ab51f4f3cf1d7c12fe9c834e0d928eed">release_readwrite</a> (void *data, distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is called when read/write access is no longer needed. <a href="#ab51f4f3cf1d7c12fe9c834e0d928eed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="298aa395de6f1a03a0d63a6e55458c44"></a><!-- doxytag: member="sc::MemoryGrp::sum_reduction" ref="298aa395de6f1a03a0d63a6e55458c44" args="(double *data, distsize_t doffset, int dsize)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>sum_reduction</b> (double *data, distsize_t doffset, int dsize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="975721a82d486e3d0afd6e6d4f9cc872"></a><!-- doxytag: member="sc::MemoryGrp::sum_reduction_on_node" ref="975721a82d486e3d0afd6e6d4f9cc872" args="(double *data, size_t doffset, int dsize, int node=-1)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>sum_reduction_on_node</b> (double *data, size_t doffset, int dsize, int node=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#0ef395631d3e3b7fe740e28bb7d9f571">sync</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Synchronizes all the nodes. <a href="#0ef395631d3e3b7fe740e28bb7d9f571"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#026f90c96fb4c9523327c4943005131c">malloc_local</a> (size_t nbyte)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate data that will be accessed locally only. <a href="#026f90c96fb4c9523327c4943005131c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49955599f41945b67a2950f1893a3540"></a><!-- doxytag: member="sc::MemoryGrp::malloc_local_double" ref="49955599f41945b67a2950f1893a3540" args="(size_t ndouble)" -->
virtual double * </td><td class="memItemRight" valign="bottom"><b>malloc_local_double</b> (size_t ndouble)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#d2bfbe8d9d28611a16660064795df0db">free_local</a> (void *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free data that was allocated with malloc_local_double. <a href="#d2bfbe8d9d28611a16660064795df0db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05885a041bcd810bc72510772bb7b202"></a><!-- doxytag: member="sc::MemoryGrp::free_local_double" ref="05885a041bcd810bc72510772bb7b202" args="(double *data)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>free_local_double</b> (double *data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#f72d6e855cf5d1bc1eae03f690b1ac75">catchup</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Processes outstanding requests. <a href="#f72d6e855cf5d1bc1eae03f690b1ac75"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9574150fb8dfbe8fd46de5fba60d5c0a"></a><!-- doxytag: member="sc::MemoryGrp::print" ref="9574150fb8dfbe8fd46de5fba60d5c0a" args="(std::ostream &o=ExEnv::out0()) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#9574150fb8dfbe8fd46de5fba60d5c0a">print</a> (std::ostream &o=ExEnv::out0()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints out information about the object. <br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsc_1_1MemoryGrp.html">MemoryGrp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#49c0712144fb5f38997678f833122ca4">initial_memorygrp</a> (int &argc, char **argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a memory group. <a href="#49c0712144fb5f38997678f833122ca4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="462844e2059e32da984cfcb331d97ba8"></a><!-- doxytag: member="sc::MemoryGrp::initial_memorygrp" ref="462844e2059e32da984cfcb331d97ba8" args="()" -->
static <a class="el" href="classsc_1_1MemoryGrp.html">MemoryGrp</a> * </td><td class="memItemRight" valign="bottom"><b>initial_memorygrp</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#41fdf83fb404c5f1c5b0daab4bc0b3ff">set_default_memorygrp</a> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1MemoryGrp.html">MemoryGrp</a> > &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default memory group contains the primary memory group to be used by an application. <a href="#41fdf83fb404c5f1c5b0daab4bc0b3ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsc_1_1MemoryGrp.html">MemoryGrp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MemoryGrp.html#00e239959d75cf50d70e525224587732">get_default_memorygrp</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the default memory group. <a href="#00e239959d75cf50d70e525224587732"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9594848a66c69206cdf6643fc88173d7"></a><!-- doxytag: member="sc::MemoryGrp::obtain_local_lock" ref="9594848a66c69206cdf6643fc88173d7" args="(size_t start, size_t fence)" -->
void </td><td class="memItemRight" valign="bottom"><b>obtain_local_lock</b> (size_t start, size_t fence)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbb34d3e09158f4b0aaf5e820cb93810"></a><!-- doxytag: member="sc::MemoryGrp::release_local_lock" ref="cbb34d3e09158f4b0aaf5e820cb93810" args="(size_t start, size_t fence)" -->
void </td><td class="memItemRight" valign="bottom"><b>release_local_lock</b> (size_t start, size_t fence)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2491de5b7679913574eba6ae2d0dbb88"></a><!-- doxytag: member="sc::MemoryGrp::me_" ref="2491de5b7679913574eba6ae2d0dbb88" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>me_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16c9d235c519f4092908b550cb058181"></a><!-- doxytag: member="sc::MemoryGrp::n_" ref="16c9d235c519f4092908b550cb058181" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>n_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c09a3a6591fd8f2e3521f61c346a3090"></a><!-- doxytag: member="sc::MemoryGrp::offsets_" ref="c09a3a6591fd8f2e3521f61c346a3090" args="" -->
distsize_t * </td><td class="memItemRight" valign="bottom"><b>offsets_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="921e38186ab83a348f6b628d6c529b94"></a><!-- doxytag: member="sc::MemoryGrp::debug_" ref="921e38186ab83a348f6b628d6c529b94" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>debug_</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classsc_1_1MemoryGrp.html" title="The MemoryGrp abstract class provides a way of accessing distributed memory in a...">MemoryGrp</a> abstract class provides a way of accessing distributed memory in a parallel machine.
<p>
Several specializations are available. For one processor, <a class="el" href="classsc_1_1ProcMemoryGrp.html" title="The ProcMemoryGrp concrete class provides an implementation of MemoryGrp for a single...">ProcMemoryGrp</a> provides a simple stub implementation. Parallel specializations include <a class="el" href="classsc_1_1ShmMemoryGrp.html" title="The ShmMemoryGrp concrete class provides an implementation of MsgMemoryGrp.">ShmMemoryGrp</a>, <a class="el" href="classsc_1_1MTMPIMemoryGrp.html" title="This MemoryGrp class requires a MT-safe MPI implementation.">MTMPIMemoryGrp</a>, and <a class="el" href="classsc_1_1ARMCIMemoryGrp.html" title="The ARMCIMemoryGrp concrete class provides an implementation of MsgMemoryGrp.">ARMCIMemoryGrp</a>. The particular specializations that work depend highly on the target hardware and software environment. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f72d6e855cf5d1bc1eae03f690b1ac75"></a><!-- doxytag: member="sc::MemoryGrp::catchup" ref="f72d6e855cf5d1bc1eae03f690b1ac75" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sc::MemoryGrp::catchup </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Processes outstanding requests.
<p>
Some memory group implementations don't have access to real shared memory or even active messages. Instead, requests are processed whenever certain memory group routines are called. This can cause large latencies and buffer overflows. If this is a problem, then the catchup member can be called to process all outstanding requests.
</div>
</div><p>
<a class="anchor" name="d2bfbe8d9d28611a16660064795df0db"></a><!-- doxytag: member="sc::MemoryGrp::free_local" ref="d2bfbe8d9d28611a16660064795df0db" args="(void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sc::MemoryGrp::free_local </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Free data that was allocated with malloc_local_double.
<p>
<p>Reimplemented in <a class="el" href="classsc_1_1ARMCIMemoryGrp.html#e521cc798ab160f65f66d02eaccb2dec">sc::ARMCIMemoryGrp</a>.</p>
</div>
</div><p>
<a class="anchor" name="00e239959d75cf50d70e525224587732"></a><!-- doxytag: member="sc::MemoryGrp::get_default_memorygrp" ref="00e239959d75cf50d70e525224587732" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classsc_1_1MemoryGrp.html">MemoryGrp</a>* sc::MemoryGrp::get_default_memorygrp </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the default memory group.
<p>
If the default memory group has not yet been set, then one is created. The particular specialization used is determined by configuration options and which specializations are being used for <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a> and <a class="el" href="classsc_1_1ThreadGrp.html" title="The ThreadGrp abstract class provides a means to manage separate threads of control...">ThreadGrp</a>.
</div>
</div><p>
<a class="anchor" name="49c0712144fb5f38997678f833122ca4"></a><!-- doxytag: member="sc::MemoryGrp::initial_memorygrp" ref="49c0712144fb5f38997678f833122ca4" args="(int &argc, char **argv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classsc_1_1MemoryGrp.html">MemoryGrp</a>* sc::MemoryGrp::initial_memorygrp </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>argv</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a memory group.
<p>
This routine looks for a -memorygrp argument, and then the environmental variable MEMORYGRP to decide which specialization of <a class="el" href="classsc_1_1MemoryGrp.html" title="The MemoryGrp abstract class provides a way of accessing distributed memory in a...">MemoryGrp</a> would be appropriate. The argument to -memorygrp or the value of the environmental variable should be either string for a <a class="el" href="classsc_1_1ParsedKeyVal.html" title="Converts textual information into keyword/value assocations.">ParsedKeyVal</a> constructor or a classname. The default <a class="el" href="classsc_1_1ThreadGrp.html" title="The ThreadGrp abstract class provides a means to manage separate threads of control...">ThreadGrp</a> and <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a> objects should be initialized before this is called.
</div>
</div><p>
<a class="anchor" name="026f90c96fb4c9523327c4943005131c"></a><!-- doxytag: member="sc::MemoryGrp::malloc_local" ref="026f90c96fb4c9523327c4943005131c" args="(size_t nbyte)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* sc::MemoryGrp::malloc_local </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>nbyte</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate data that will be accessed locally only.
<p>
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.
<p>Reimplemented in <a class="el" href="classsc_1_1ARMCIMemoryGrp.html#ae4c0f8a771a059a3f019e42df64313e">sc::ARMCIMemoryGrp</a>.</p>
</div>
</div><p>
<a class="anchor" name="adba96c579589e6be4ce48bd275137a0"></a><!-- doxytag: member="sc::MemoryGrp::obtain_readwrite" ref="adba96c579589e6be4ce48bd275137a0" args="(distsize_t offset, int size)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* sc::MemoryGrp::obtain_readwrite </td>
<td>(</td>
<td class="paramtype">distsize_t </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Only one thread can have an unreleased obtain_readwrite at a time.
<p>
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.
<p>Implemented in <a class="el" href="classsc_1_1ActiveMsgMemoryGrp.html#613932193268365d56eda08873cca65f">sc::ActiveMsgMemoryGrp</a>, <a class="el" href="classsc_1_1ProcMemoryGrp.html#5fce1d7720a4282e64b24e30f1f84169">sc::ProcMemoryGrp</a>, <a class="el" href="classsc_1_1RDMAMemoryGrp.html#22ac29f224a65fafbaea14e0cc45933f">sc::RDMAMemoryGrp</a>, and <a class="el" href="classsc_1_1ShmMemoryGrp.html#8419a95ca4976f05af852f92f2e7e574">sc::ShmMemoryGrp</a>.</p>
</div>
</div><p>
<a class="anchor" name="ab51f4f3cf1d7c12fe9c834e0d928eed"></a><!-- doxytag: member="sc::MemoryGrp::release_readwrite" ref="ab51f4f3cf1d7c12fe9c834e0d928eed" args="(void *data, distsize_t offset, int size)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sc::MemoryGrp::release_readwrite </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">distsize_t </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is called when read/write access is no longer needed.
<p>
The memory will be unlocked.
<p>Implemented in <a class="el" href="classsc_1_1ActiveMsgMemoryGrp.html#9eef3abc6db3efd9d20869c8a028237b">sc::ActiveMsgMemoryGrp</a>, <a class="el" href="classsc_1_1ProcMemoryGrp.html#d19482fe2eb8439ffdff7e8ae2a94830">sc::ProcMemoryGrp</a>, <a class="el" href="classsc_1_1RDMAMemoryGrp.html#f724dded9e2334c27e91d90d13d548c4">sc::RDMAMemoryGrp</a>, and <a class="el" href="classsc_1_1ShmMemoryGrp.html#2f867c71cba7eb0f724f622201c35a36">sc::ShmMemoryGrp</a>.</p>
</div>
</div><p>
<a class="anchor" name="41fdf83fb404c5f1c5b0daab4bc0b3ff"></a><!-- doxytag: member="sc::MemoryGrp::set_default_memorygrp" ref="41fdf83fb404c5f1c5b0daab4bc0b3ff" args="(const Ref< MemoryGrp > &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void sc::MemoryGrp::set_default_memorygrp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1MemoryGrp.html">MemoryGrp</a> > & </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The default memory group contains the primary memory group to be used by an application.
<p>
</div>
</div><p>
<a class="anchor" name="4ee243438a21eb017e3f5f6624ab9cfc"></a><!-- doxytag: member="sc::MemoryGrp::set_localsize" ref="4ee243438a21eb017e3f5f6624ab9cfc" args="(size_t)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sc::MemoryGrp::set_localsize </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the size of locally held memory.
<p>
When memory is accessed using a global offset counting starts at node 0 and proceeds up to node <a class="el" href="classsc_1_1MemoryGrp.html#a2f204165147154bd15600ea8929b3c6" title="Returns how many nodes there are.">n()</a> - 1.
<p>Implemented in <a class="el" href="classsc_1_1ActiveMsgMemoryGrp.html#60953da3be5901a6f90fff5a80e028b3">sc::ActiveMsgMemoryGrp</a>, <a class="el" href="classsc_1_1ARMCIMemoryGrp.html#8d0b5d860b35b2510ddb2a4b88ef2503">sc::ARMCIMemoryGrp</a>, <a class="el" href="classsc_1_1MsgMemoryGrp.html#902db59bfb4f13979efa58b7d9077b53">sc::MsgMemoryGrp</a>, <a class="el" href="classsc_1_1ProcMemoryGrp.html#056878e285deaac6953288e517254b0f">sc::ProcMemoryGrp</a>, <a class="el" href="classsc_1_1RDMAMemoryGrp.html#49c353380e4629ae9222bda6708e5524">sc::RDMAMemoryGrp</a>, and <a class="el" href="classsc_1_1ShmMemoryGrp.html#ed4877a530a377d18ad6ea8529f9866c">sc::ShmMemoryGrp</a>.</p>
</div>
</div><p>
<a class="anchor" name="0ef395631d3e3b7fe740e28bb7d9f571"></a><!-- doxytag: member="sc::MemoryGrp::sync" ref="0ef395631d3e3b7fe740e28bb7d9f571" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sc::MemoryGrp::sync </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Synchronizes all the nodes.
<p>
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.
<p>Implemented in <a class="el" href="classsc_1_1ARMCIMemoryGrp.html#56a6e1bd41abd4b944fcf59b58a2f2e8">sc::ARMCIMemoryGrp</a>, <a class="el" href="classsc_1_1MsgMemoryGrp.html#0fd841a6c2d1547a8d66134f787f1cdc">sc::MsgMemoryGrp</a>, <a class="el" href="classsc_1_1MTMPIMemoryGrp.html#113a2c3b575498f47461ada78237ddd8">sc::MTMPIMemoryGrp</a>, and <a class="el" href="classsc_1_1ProcMemoryGrp.html#389e3d5108254f46fab8d3e44066119c">sc::ProcMemoryGrp</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="memory_8h_source.html">memory.h</a></ul>
</div>
<hr>
<address>
<small>
Generated at Wed Oct 14 14:12:16 2009 for <a
href="http://www.mpqc.org">MPQC</a>
2.3.1 using the documentation package <a
href="http://www.doxygen.org">Doxygen</a>
1.5.9.
</small>
</address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
247b28499c443e092731ffba814075f2
>
files
>
422
