summaryrefslogtreecommitdiffstats
path: root/develop/struct_h5_f_d__subfiling__params__t.html
blob: 62d9a00ec49d8f14a885c1968bf8feff4c138ff9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: H5FD_subfiling_params_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
 -->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey:  <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
   &#160;<span id="projectnumber">1.15.0.68e8c0e</span>
   </div>
   <div id="projectbrief">API Reference</div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('struct_h5_f_d__subfiling__params__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">H5FD_subfiling_params_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;src/H5FDsubfiling/H5FDsubfiling.h&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Subfiling parameter structure that is shared between the <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> and <a class="el" href="_h5_f_dioc_8h.html#a9d6649a67050fb1101cca3596421b986">H5FD_IOC</a> drivers. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:abd7d99b55cfe764ad8d453a56e3c2ef2" id="r_abd7d99b55cfe764ad8d453a56e3c2ef2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7">H5FD_subfiling_ioc_select_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abd7d99b55cfe764ad8d453a56e3c2ef2">ioc_selection</a></td></tr>
<tr class="separator:abd7d99b55cfe764ad8d453a56e3c2ef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cc0974015913401902f1650df9fe54f" id="r_a3cc0974015913401902f1650df9fe54f"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3cc0974015913401902f1650df9fe54f">stripe_size</a></td></tr>
<tr class="separator:a3cc0974015913401902f1650df9fe54f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a617634abc9f1f954589052be25b538fc" id="r_a617634abc9f1f954589052be25b538fc"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a617634abc9f1f954589052be25b538fc">stripe_count</a></td></tr>
<tr class="separator:a617634abc9f1f954589052be25b538fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="abd7d99b55cfe764ad8d453a56e3c2ef2" name="abd7d99b55cfe764ad8d453a56e3c2ef2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd7d99b55cfe764ad8d453a56e3c2ef2">&#9670;&#160;</a></span>ioc_selection</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7">H5FD_subfiling_ioc_select_t</a> ioc_selection</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The method to use for selecting MPI ranks to be I/O concentrators. The current default is to select one MPI rank per node to be an I/O concentrator. Refer to <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7">H5FD_subfiling_ioc_select_t</a> for a description of the algorithms available for use. </p>

</div>
</div>
<a id="a617634abc9f1f954589052be25b538fc" name="a617634abc9f1f954589052be25b538fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a617634abc9f1f954589052be25b538fc">&#9670;&#160;</a></span>stripe_count</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t stripe_count</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The target number of subfiles to use for the logical HDF5 file. The current default is to use one subfile per node, but it can be useful to set a different target number of subfiles, especially if the HDF5 application will pre-create the HDF5 file on a single MPI rank. In that particular case, the single rank will need to know how many subfiles the logical HDF5 file will consist of in order to properly pre-create the file.</p>
<p>This value is used in conjunction with the IOC selection method to determine which MPI ranks will be assigned as I/O concentrators. Alternatively, the mapping between MPI ranks and I/O concentrators can be set or adjusted with a combination of the <a class="el" href="#abd7d99b55cfe764ad8d453a56e3c2ef2">ioc_selection</a> field and the <a class="el" href="_h5_f_dsubfiling_8h.html#a5a5883d4d3c713fdbefd27971b8a67b7">H5FD_SUBFILING_IOC_PER_NODE</a> and <a class="el" href="_h5_f_dsubfiling_8h.html#a8350a509d56b739b6cc8f4f1934d0e00">H5FD_SUBFILING_IOC_SELECTION_CRITERIA</a> environment variables. </p>

</div>
</div>
<a id="a3cc0974015913401902f1650df9fe54f" name="a3cc0974015913401902f1650df9fe54f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cc0974015913401902f1650df9fe54f">&#9670;&#160;</a></span>stripe_size</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int64_t stripe_size</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The stripe size defines the size (in bytes) of the data stripes in the subfiles for the logical HDF5 file. Data is striped across the subfiles in a round-robin wrap-around fashion in segments equal to the stripe size.</p>
<p>For example, in an HDF5 file consisting of four subfiles with a 1MiB stripe size, the first and fifth 1MiB of data would reside in the first subfile, the second and sixth 1MiB of data would reside in the second subfile and so on.</p>
<p>This value can also be set or adjusted with the <a class="el" href="_h5_f_dsubfiling_8h.html#ae3da9be3aeeedafd84cca1371b6c5da4">H5FD_SUBFILING_STRIPE_SIZE</a> environment variable. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/H5FDsubfiling/<a class="el" href="_h5_f_dsubfiling_8h.html">H5FDsubfiling.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="struct_h5_f_d__subfiling__params__t.html">H5FD_subfiling_params_t</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
  </ul>
</div>
</body>
</html>