<!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: file.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>file.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// file.h</span>
<a name="l00003"></a>00003 <span class="comment">//</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 1996 Limit Point Systems, Inc.</span>
<a name="l00005"></a>00005 <span class="comment">//</span>
<a name="l00006"></a>00006 <span class="comment">// Author: Curtis Janssen <cljanss@limitpt.com></span>
<a name="l00007"></a>00007 <span class="comment">// Maintainer: LPS</span>
<a name="l00008"></a>00008 <span class="comment">//</span>
<a name="l00009"></a>00009 <span class="comment">// This file is part of the SC Toolkit.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// The SC Toolkit is free software; you can redistribute it and/or modify</span>
<a name="l00012"></a>00012 <span class="comment">// it under the terms of the GNU Library General Public License as published by</span>
<a name="l00013"></a>00013 <span class="comment">// the Free Software Foundation; either version 2, or (at your option)</span>
<a name="l00014"></a>00014 <span class="comment">// any later version.</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016 <span class="comment">// The SC Toolkit is distributed in the hope that it will be useful,</span>
<a name="l00017"></a>00017 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00018"></a>00018 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00019"></a>00019 <span class="comment">// GNU Library General Public License for more details.</span>
<a name="l00020"></a>00020 <span class="comment">//</span>
<a name="l00021"></a>00021 <span class="comment">// You should have received a copy of the GNU Library General Public License</span>
<a name="l00022"></a>00022 <span class="comment">// along with the SC Toolkit; see the file COPYING.LIB. If not, write to</span>
<a name="l00023"></a>00023 <span class="comment">// the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00024"></a>00024 <span class="comment">//</span>
<a name="l00025"></a>00025 <span class="comment">// The U.S. Government is granted a limited license as per AL 91-7.</span>
<a name="l00026"></a>00026 <span class="comment">//</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#ifdef __GNUC__</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#pragma interface</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#ifndef _util_group_file_h</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define _util_group_file_h</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <iostream></span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor">#include <scconfig.h></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <util/class/class.h></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include <util/group/thread.h></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <util/group/memory.h></span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="keyword">namespace </span>sc {
<a name="l00043"></a>00043
<a name="l00055"></a><a class="code" href="classsc_1_1FileGrp.html">00055</a> <span class="keyword">class </span><a class="code" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>: <span class="keyword">public</span> <a class="code" href="classsc_1_1DescribedClass.html" title="Classes which need runtime information about themselves and their relationship to...">DescribedClass</a> {
<a name="l00056"></a>00056 <span class="keyword">private</span>:
<a name="l00057"></a>00057 <span class="keywordtype">int</span> datafile_;
<a name="l00058"></a>00058 <span class="keywordtype">char</span> *filename_;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <a class="code" href="classsc_1_1Ref.html">Ref<ThreadLock></a> *locks_;
<a name="l00061"></a>00061 <span class="keywordtype">int</span> nlock_;
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keywordtype">void</span> init_locks();
<a name="l00064"></a>00064
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">protected</span>:
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="comment">// derived classes must fill in all these</span>
<a name="l00069"></a>00069 <span class="comment">// ~FileGrp deletes the arrays</span>
<a name="l00070"></a>00070 <span class="keywordtype">int</span> me_;
<a name="l00071"></a>00071 <span class="keywordtype">int</span> n_;
<a name="l00072"></a>00072 distsize_t *offsets_; <span class="comment">// offsets_[n_] is the fence for all data</span>
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">// set to nonzero for debugging information</span>
<a name="l00075"></a>00075 <span class="keywordtype">int</span> debug_;
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keywordtype">void</span> obtain_local_lock(<span class="keywordtype">size_t</span> start, <span class="keywordtype">size_t</span> fence);
<a name="l00078"></a>00078 <span class="keywordtype">void</span> release_local_lock(<span class="keywordtype">size_t</span> start, <span class="keywordtype">size_t</span> fence);
<a name="l00079"></a>00079 <span class="keyword">public</span>:
<a name="l00080"></a>00080 <a class="code" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>();
<a name="l00081"></a>00081 <a class="code" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>(<span class="keyword">const</span> <a class="code" href="classsc_1_1Ref.html">Ref<KeyVal></a>&);
<a name="l00082"></a>00082 <span class="keyword">virtual</span> ~<a class="code" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>();
<a name="l00083"></a>00083
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#4d3cd5760ca784d720757545e251149e" title="Opens the files.">open</a>();
<a name="l00087"></a>00087 <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#b1dfe407f49ebc9f557367ea5ff32e4b" title="Closes the files.">close</a>();
<a name="l00089"></a>00089 <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#8bb3c4c964e856e535e918529dea181e" title="Sets the filename for the FileGrp.">set_filename</a>(<span class="keywordtype">char</span> *name);
<a name="l00091"></a><a class="code" href="classsc_1_1FileGrp.html#7aefcb818b0bd91f693bc42cdd5db308">00091</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classsc_1_1FileGrp.html#7aefcb818b0bd91f693bc42cdd5db308" title="Returns the filename for the FileGrp.">get_filename</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> datafile_; };
<a name="l00092"></a>00092
<a name="l00094"></a><a class="code" href="classsc_1_1FileGrp.html#eeacf0973b402c7da3b3c2d2a945e4ba">00094</a> <span class="keywordtype">int</span> <a class="code" href="classsc_1_1FileGrp.html#eeacf0973b402c7da3b3c2d2a945e4ba" title="Returns who I am.">me</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> me_; }
<a name="l00096"></a><a class="code" href="classsc_1_1FileGrp.html#0b0cd42d0eb3b7d5197811d498dd97c3">00096</a> <span class="keywordtype">int</span> <a class="code" href="classsc_1_1FileGrp.html#0b0cd42d0eb3b7d5197811d498dd97c3" title="Returns how many nodes there are.">n</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> n_; }
<a name="l00097"></a>00097
<a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#f3c0d0bebc58de111acf28c333977091" title="Set the size of locally held data.">set_localsize</a>(<span class="keywordtype">size_t</span>) = 0;
<a name="l00103"></a><a class="code" href="classsc_1_1FileGrp.html#9dc0b00e30683ea9f36b5ae74957ff54">00103</a> <span class="keywordtype">size_t</span> <a class="code" href="classsc_1_1FileGrp.html#9dc0b00e30683ea9f36b5ae74957ff54" title="Returns the amount of data residing locally on me().">localsize</a>() { <span class="keywordflow">return</span> distsize_to_size(offsets_[me_+1]-offsets_[me_]); }
<a name="l00105"></a><a class="code" href="classsc_1_1FileGrp.html#a507540c3a6d0c702067e66276f2b28a">00105</a> distsize_t <a class="code" href="classsc_1_1FileGrp.html#a507540c3a6d0c702067e66276f2b28a" title="Returns the global offset to this node&#39;s data.">localoffset</a>() { <span class="keywordflow">return</span> offsets_[me_]; }
<a name="l00107"></a><a class="code" href="classsc_1_1FileGrp.html#6551664f81c13b3c20cb629a2f540023">00107</a> <span class="keywordtype">int</span> <a class="code" href="classsc_1_1FileGrp.html#6551664f81c13b3c20cb629a2f540023" title="Returns the amount of data residing on node.">size</a>(<span class="keywordtype">int</span> node)
<a name="l00108"></a>00108 { <span class="keywordflow">return</span> distsize_to_size(offsets_[node+1] - offsets_[node]); }
<a name="l00110"></a><a class="code" href="classsc_1_1FileGrp.html#b6d94c169f58d39d23605dca93a74903">00110</a> distsize_t <a class="code" href="classsc_1_1FileGrp.html#b6d94c169f58d39d23605dca93a74903" title="Returns the global offset to node&#39;s data.">offset</a>(<span class="keywordtype">int</span> node) { <span class="keywordflow">return</span> offsets_[node]; }
<a name="l00112"></a><a class="code" href="classsc_1_1FileGrp.html#3a0501f1133eeda5cf32bbeba91eb0a4">00112</a> distsize_t <a class="code" href="classsc_1_1FileGrp.html#3a0501f1133eeda5cf32bbeba91eb0a4" title="Returns the sum of all data allocated on all nodes.">totalsize</a>() { <span class="keywordflow">return</span> offsets_[n_]; }
<a name="l00113"></a>00113
<a name="l00115"></a>00115 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#88937aa7100a75ab5702aa0cc9a9348d" title="Activate is called before the data is to be used.">activate</a>();
<a name="l00117"></a>00117 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#2ba7caab1e304ce3a5590cbd57cf822f" title="Deactivate is called after the data has been used.">deactivate</a>();
<a name="l00118"></a>00118
<a name="l00120"></a>00120 <span class="keyword">virtual</span> <span class="keywordtype">void</span> *<a class="code" href="classsc_1_1FileGrp.html#4db5e65f5b418bb8f340e94bee2c2991" title="This gives write access to the data location. No locking is done.">obtain_writeonly</a>(distsize_t <a class="code" href="classsc_1_1FileGrp.html#b6d94c169f58d39d23605dca93a74903" title="Returns the global offset to node&#39;s data.">offset</a>, <span class="keywordtype">int</span> <a class="code" href="classsc_1_1FileGrp.html#6551664f81c13b3c20cb629a2f540023" title="Returns the amount of data residing on node.">size</a>) = 0;
<a name="l00126"></a>00126 <span class="keyword">virtual</span> <span class="keywordtype">void</span> *<a class="code" href="classsc_1_1FileGrp.html#2cc72b52a6ff1d30b49302b5ad3c15ac" title="Only one thread can have an unreleased obtain_readwrite at a time.">obtain_readwrite</a>(distsize_t <a class="code" href="classsc_1_1FileGrp.html#b6d94c169f58d39d23605dca93a74903" title="Returns the global offset to node&#39;s data.">offset</a>, <span class="keywordtype">int</span> <a class="code" href="classsc_1_1FileGrp.html#6551664f81c13b3c20cb629a2f540023" title="Returns the amount of data residing on node.">size</a>) = 0;
<a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keywordtype">void</span> *<a class="code" href="classsc_1_1FileGrp.html#32a07e227af5cdbb30fd5516344671c4" title="This gives read access to the file location. No locking is done.">obtain_readonly</a>(distsize_t <a class="code" href="classsc_1_1FileGrp.html#b6d94c169f58d39d23605dca93a74903" title="Returns the global offset to node&#39;s data.">offset</a>, <span class="keywordtype">int</span> <a class="code" href="classsc_1_1FileGrp.html#6551664f81c13b3c20cb629a2f540023" title="Returns the amount of data residing on node.">size</a>) = 0;
<a name="l00130"></a>00130 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#060301208ed173cbbb35e56eb7e60744" title="This is called when read access is no longer needed.">release_readonly</a>(<span class="keywordtype">void</span> *data, distsize_t <a class="code" href="classsc_1_1FileGrp.html#b6d94c169f58d39d23605dca93a74903" title="Returns the global offset to node&#39;s data.">offset</a>, <span class="keywordtype">int</span> <a class="code" href="classsc_1_1FileGrp.html#6551664f81c13b3c20cb629a2f540023" title="Returns the amount of data residing on node.">size</a>) = 0;
<a name="l00132"></a>00132 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#28241a684ef59c0ee0dc7d798984e7e6" title="This is called when write access is no longer needed.">release_writeonly</a>(<span class="keywordtype">void</span> *data, distsize_t <a class="code" href="classsc_1_1FileGrp.html#b6d94c169f58d39d23605dca93a74903" title="Returns the global offset to node&#39;s data.">offset</a>, <span class="keywordtype">int</span> <a class="code" href="classsc_1_1FileGrp.html#6551664f81c13b3c20cb629a2f540023" title="Returns the amount of data residing on node.">size</a>)=0;
<a name="l00135"></a>00135 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#fb5c732e25f5c97cb01286a2a859390a" title="This is called when read/write access is no longer needed.">release_readwrite</a>(<span class="keywordtype">void</span> *data, distsize_t <a class="code" href="classsc_1_1FileGrp.html#b6d94c169f58d39d23605dca93a74903" title="Returns the global offset to node&#39;s data.">offset</a>, <span class="keywordtype">int</span> <a class="code" href="classsc_1_1FileGrp.html#6551664f81c13b3c20cb629a2f540023" title="Returns the amount of data residing on node.">size</a>)=0;
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keyword">virtual</span> <span class="keywordtype">void</span> sum_reduction(<span class="keywordtype">double</span> *data, distsize_t doffset, <span class="keywordtype">int</span> dsize);
<a name="l00138"></a>00138 <span class="keyword">virtual</span> <span class="keywordtype">void</span> sum_reduction_on_node(<span class="keywordtype">double</span> *data, <span class="keywordtype">size_t</span> doffset, <span class="keywordtype">int</span> dsize,
<a name="l00139"></a>00139 <span class="keywordtype">int</span> node = -1);
<a name="l00140"></a>00140
<a name="l00143"></a>00143 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#764899ffda84b68b052cf896ae251131" title="Synchronizes all the nodes.">sync</a>() = 0;
<a name="l00144"></a>00144
<a name="l00151"></a>00151 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#ca5697a4320bd23a1a43235f3affca4b" title="Processes outstanding requests.">catchup</a>();
<a name="l00152"></a>00152
<a name="l00154"></a>00154 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#860f2807e181f935562d7b2f27e240d9" title="Prints out information about the object.">print</a>(std::ostream &o = <a class="code" href="classsc_1_1ExEnv.html#360216acd1f990e999c0ed46cb350b1f" title="Return an ostream that writes from node 0.">ExEnv::out0</a>()) <span class="keyword">const</span>;
<a name="l00155"></a>00155
<a name="l00163"></a>00163 <span class="keyword">static</span> <a class="code" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>* initial_filegrp(<span class="keywordtype">int</span> &argc, <span class="keywordtype">char</span>** argv);
<a name="l00164"></a>00164 <span class="keyword">static</span> <a class="code" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>* initial_filegrp();
<a name="l00167"></a>00167 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1FileGrp.html#74f4c1961c1a3c09c5ca59e5fabdc5aa" title="The default file group contains the primary file group to be used by an application...">set_default_filegrp</a>(<span class="keyword">const</span> <a class="code" href="classsc_1_1Ref.html" title="A template class that maintains references counts.">Ref<FileGrp></a>&);
<a name="l00169"></a>00169 <span class="keyword">static</span> <a class="code" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>* <a class="code" href="classsc_1_1FileGrp.html#6dd93351ea013c8da3d18b12b505bcfc" title="Returns the default file group.">get_default_filegrp</a>();
<a name="l00171"></a>00171 <span class="keyword">virtual</span> <a class="code" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>* <a class="code" href="classsc_1_1FileGrp.html#16e63c6a1ad6391620b9910209f2a18c" title="Clones the given FileGrp. The new FileGrp may need to be initialized additionally...">clone</a>() =0;
<a name="l00172"></a>00172 };
<a name="l00173"></a>00173
<a name="l00174"></a>00174 }
<a name="l00175"></a>00175
<a name="l00176"></a>00176 <span class="preprocessor">#endif</span>
<a name="l00177"></a>00177 <span class="preprocessor"></span>
<a name="l00178"></a>00178 <span class="comment">// Local Variables:</span>
<a name="l00179"></a>00179 <span class="comment">// mode: c++</span>
<a name="l00180"></a>00180 <span class="comment">// c-file-style: "CLJ"</span>
<a name="l00181"></a>00181 <span class="comment">// End:</span>
</pre></div></div>
<hr>
<address>
<small>
Generated at Wed Oct 14 14:12:09 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
>
1058
