diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
| commit | d12e43bc201e15edffcdf94fe820aeae6ab44882 (patch) | |
| tree | 90aa12006b20849b65b7bc8e3d4fe60a488f7247 /_h5_f_dsubfiling_8h.html | |
| parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
| download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 | |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to '_h5_f_dsubfiling_8h.html')
| -rw-r--r-- | _h5_f_dsubfiling_8h.html | 461 |
1 files changed, 461 insertions, 0 deletions
diff --git a/_h5_f_dsubfiling_8h.html b/_h5_f_dsubfiling_8h.html new file mode 100644 index 0000000..0dfa9b4 --- /dev/null +++ b/_h5_f_dsubfiling_8h.html @@ -0,0 +1,461 @@ +<!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.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>HDF5: src/H5FDsubfiling/H5FDsubfiling.h File 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> +<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(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> +  <span id="projectnumber">1.15.0.ab4d2ae</span> + </div> + <div id="projectbrief">API Reference</div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.svg" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="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.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('_h5_f_dsubfiling_8h.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"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Data Structures</a> | +<a href="#define-members">Macros</a> | +<a href="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">H5FDsubfiling.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-0-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div> +<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-0-content" class="dyncontent" style="display:none;"> +<div class="center"><img src="_h5_f_dsubfiling_8h__dep__incl.png" border="0" usemap="#asrc_2_h5_f_dsubfiling_2_h5_f_dsubfiling_8hdep" alt=""/></div> +<map name="asrc_2_h5_f_dsubfiling_2_h5_f_dsubfiling_8hdep" id="asrc_2_h5_f_dsubfiling_2_h5_f_dsubfiling_8hdep"> +<area shape="rect" title=" " alt="" coords="148,5,391,32"/> +<area shape="rect" href="_h5_f_dioc_8h.html" title=" " alt="" coords="95,80,302,107"/> +<area shape="rect" href="_h5_f_dsubfiling__priv_8h.html" title=" " alt="" coords="225,155,455,196"/> +<area shape="rect" href="_h5_f_dioc__priv_8h.html" title=" " alt="" coords="5,155,200,196"/> +</map> +</div> +</div><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Data Structures</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__subfiling__params__t.html">H5FD_subfiling_params_t</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="struct_h5_f_d__subfiling__params__t.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__subfiling__config__t.html">H5FD_subfiling_config_t</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Configuration structure for <a class="el" href="group___f_a_p_l.html#ga65dbddbba216fdd0bdf99b4feaa74db2" title="Modifies the specified File Access Property List to use the H5FD_SUBFILING driver.">H5Pset_fapl_subfiling()</a> / <a class="el" href="group___f_a_p_l.html#ga2af70900a3ea50a83d65f8285730ef45" title="Queries a File Access Property List for H5FD_SUBFILING file driver properties.">H5Pget_fapl_subfiling()</a> <a href="struct_h5_f_d__subfiling__config__t.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:a070ba7b51cfe718ba4da75b308066a9d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a>   (<a class="el" href="_h5_f_ddevelop_8h.html#a4df4d59c642c469f7a2c8934bfc84d60">H5FDperform_init</a>(<a class="el" href="_h5_f_dsubfiling_8h.html#ac2f254c2f4f5ca9a319584c731f2b280">H5FD_subfiling_init</a>))</td></tr> +<tr class="separator:a070ba7b51cfe718ba4da75b308066a9d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaa2dd4d2965df35e172a5195cadb9de2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#aaa2dd4d2965df35e172a5195cadb9de2">H5FD_SUBFILING_NAME</a>   "subfiling"</td></tr> +<tr class="separator:aaa2dd4d2965df35e172a5195cadb9de2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abaa42bc15a5d58b141de7147ac4c4a4c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#abaa42bc15a5d58b141de7147ac4c4a4c">H5FD_SUBFILING_CURR_FAPL_VERSION</a>   1</td></tr> +<tr class="separator:abaa42bc15a5d58b141de7147ac4c4a4c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a923120a6d3f217a8545bd654f5646cb7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#a923120a6d3f217a8545bd654f5646cb7">H5FD_SUBFILING_FAPL_MAGIC</a>   0xFED01331</td></tr> +<tr class="separator:a923120a6d3f217a8545bd654f5646cb7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6613027f8ed05f42be046721d40dbd56"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#a6613027f8ed05f42be046721d40dbd56">H5FD_SUBFILING_DEFAULT_STRIPE_SIZE</a>   (32 * 1024 * 1024)</td></tr> +<tr class="separator:a6613027f8ed05f42be046721d40dbd56"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5b6cb61c4ef9e55eca8cdfec8c1039c7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#a5b6cb61c4ef9e55eca8cdfec8c1039c7">H5FD_SUBFILING_DEFAULT_STRIPE_COUNT</a>   -1</td></tr> +<tr class="separator:a5b6cb61c4ef9e55eca8cdfec8c1039c7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acae2194f0e4325e41c4ab600b581e811"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#acae2194f0e4325e41c4ab600b581e811">H5FD_SUBFILING_FILENAME_TEMPLATE</a>   "%s.subfile_%" PRIu64 "_%0*d_of_%d"</td></tr> +<tr class="separator:acae2194f0e4325e41c4ab600b581e811"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae97d2f017ab878d921ac75ce1ee7bc9d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#ae97d2f017ab878d921ac75ce1ee7bc9d">H5FD_SUBFILING_CONFIG_FILENAME_TEMPLATE</a>   "%s.subfile_%" PRIu64 ".config"</td></tr> +<tr class="separator:ae97d2f017ab878d921ac75ce1ee7bc9d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae3da9be3aeeedafd84cca1371b6c5da4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#ae3da9be3aeeedafd84cca1371b6c5da4">H5FD_SUBFILING_STRIPE_SIZE</a>   "H5FD_SUBFILING_STRIPE_SIZE"</td></tr> +<tr class="separator:ae3da9be3aeeedafd84cca1371b6c5da4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5a5883d4d3c713fdbefd27971b8a67b7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#a5a5883d4d3c713fdbefd27971b8a67b7">H5FD_SUBFILING_IOC_PER_NODE</a>   "H5FD_SUBFILING_IOC_PER_NODE"</td></tr> +<tr class="separator:a5a5883d4d3c713fdbefd27971b8a67b7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8350a509d56b739b6cc8f4f1934d0e00"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#a8350a509d56b739b6cc8f4f1934d0e00">H5FD_SUBFILING_IOC_SELECTION_CRITERIA</a>   "H5FD_SUBFILING_IOC_SELECTION_CRITERIA"</td></tr> +<tr class="separator:a8350a509d56b739b6cc8f4f1934d0e00"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a837b185b9e78252d295c33c8f86e46f3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#a837b185b9e78252d295c33c8f86e46f3">H5FD_SUBFILING_SUBFILE_PREFIX</a>   "H5FD_SUBFILING_SUBFILE_PREFIX"</td></tr> +<tr class="separator:a837b185b9e78252d295c33c8f86e46f3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a70a3432b7e53fba2eaf36e072540c44c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#a70a3432b7e53fba2eaf36e072540c44c">H5FD_SUBFILING_CONFIG_FILE_PREFIX</a>   "H5FD_SUBFILING_CONFIG_FILE_PREFIX"</td></tr> +<tr class="separator:a70a3432b7e53fba2eaf36e072540c44c"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:a2bcf2d531a0668895308692b0c1108d7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7">H5FD_subfiling_ioc_select_t</a> { <br /> +  <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7a8f225a77916a61e89ac2cc94309fa16b">SELECT_IOC_ONE_PER_NODE</a> = 0 +, <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7ab3e4d0db99c1560e49263961850bf82e">SELECT_IOC_EVERY_NTH_RANK</a> +, <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7a6f9c0d42898b8e2604747189f6ee81ed">SELECT_IOC_WITH_CONFIG</a> +, <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7a12d13fbd9db7189a5ddcd52a2ff08d55">SELECT_IOC_TOTAL</a> +, <br /> +  <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7a3709cb22d2a065ec62e5d72057564649">ioc_selection_options</a> +<br /> + }</td></tr> +<tr class="separator:a2bcf2d531a0668895308692b0c1108d7"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ac2f254c2f4f5ca9a319584c731f2b280"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_h5_f_dsubfiling_8h.html#ac2f254c2f4f5ca9a319584c731f2b280">H5FD_subfiling_init</a> (void)</td></tr> +<tr class="memdesc:ac2f254c2f4f5ca9a319584c731f2b280"><td class="mdescLeft"> </td><td class="mdescRight">Internal routine to initialize <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> driver. Not meant to be called directly by an HDF5 application. <a href="_h5_f_dsubfiling_8h.html#ac2f254c2f4f5ca9a319584c731f2b280">More...</a><br /></td></tr> +<tr class="separator:ac2f254c2f4f5ca9a319584c731f2b280"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga65dbddbba216fdd0bdf99b4feaa74db2"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_a_p_l.html#ga65dbddbba216fdd0bdf99b4feaa74db2">H5Pset_fapl_subfiling</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, const <a class="el" href="struct_h5_f_d__subfiling__config__t.html">H5FD_subfiling_config_t</a> *vfd_config)</td></tr> +<tr class="memdesc:ga65dbddbba216fdd0bdf99b4feaa74db2"><td class="mdescLeft"> </td><td class="mdescRight">Modifies the specified File Access Property List to use the <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> driver. <a href="group___f_a_p_l.html#ga65dbddbba216fdd0bdf99b4feaa74db2">More...</a><br /></td></tr> +<tr class="separator:ga65dbddbba216fdd0bdf99b4feaa74db2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2af70900a3ea50a83d65f8285730ef45"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_a_p_l.html#ga2af70900a3ea50a83d65f8285730ef45">H5Pget_fapl_subfiling</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, <a class="el" href="struct_h5_f_d__subfiling__config__t.html">H5FD_subfiling_config_t</a> *config_out)</td></tr> +<tr class="memdesc:ga2af70900a3ea50a83d65f8285730ef45"><td class="mdescLeft"> </td><td class="mdescRight">Queries a File Access Property List for <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> file driver properties. <a href="group___f_a_p_l.html#ga2af70900a3ea50a83d65f8285730ef45">More...</a><br /></td></tr> +<tr class="separator:ga2af70900a3ea50a83d65f8285730ef45"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a id="a070ba7b51cfe718ba4da75b308066a9d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a070ba7b51cfe718ba4da75b308066a9d">◆ </a></span>H5FD_SUBFILING</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING   (<a class="el" href="_h5_f_ddevelop_8h.html#a4df4d59c642c469f7a2c8934bfc84d60">H5FDperform_init</a>(<a class="el" href="_h5_f_dsubfiling_8h.html#ac2f254c2f4f5ca9a319584c731f2b280">H5FD_subfiling_init</a>))</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Macro that returns the identifier for the <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> driver. Returns a file driver identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>. </p> + +</div> +</div> +<a id="a70a3432b7e53fba2eaf36e072540c44c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a70a3432b7e53fba2eaf36e072540c44c">◆ </a></span>H5FD_SUBFILING_CONFIG_FILE_PREFIX</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_CONFIG_FILE_PREFIX   "H5FD_SUBFILING_CONFIG_FILE_PREFIX"</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Macro for name of the environment variable that specifies a prefix to apply to the subfiling configuration filename. Useful for cases where the application wants to place the configuration file in a different directory than the default of putting it alongside the generated subfiles. For example, when writing to node-local storage one may wish to place the configuration file on a scratch file system readable by all nodes, while the subfiles are initially written to the node-local storage.</p> +<p>The value set for this environment variable is interpreted as a pathname that must already exist.</p> +<p>NOTE: As this prefix string will be encoded in the driver info message that gets written to the file, there is an upper limit of about ~900 single-byte characters for this string, though possibly less due to other information the driver may encode. Avoid long prefix names where possible. </p> + +</div> +</div> +<a id="ae97d2f017ab878d921ac75ce1ee7bc9d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae97d2f017ab878d921ac75ce1ee7bc9d">◆ </a></span>H5FD_SUBFILING_CONFIG_FILENAME_TEMPLATE</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_CONFIG_FILENAME_TEMPLATE   "%s.subfile_%" PRIu64 ".config"</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The basic template for a <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> driver configuration filename. The format specifiers correspond to:</p> +<p>s -> base filename, e.g. "file.h5" PRIu64 -> file inode, e.g. 11273556</p> +<p>yielding a filename such as:</p> +<p>file.h5.subfile_11273556.config </p> + +</div> +</div> +<a id="abaa42bc15a5d58b141de7147ac4c4a4c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abaa42bc15a5d58b141de7147ac4c4a4c">◆ </a></span>H5FD_SUBFILING_CURR_FAPL_VERSION</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_CURR_FAPL_VERSION   1</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The version number of the <a class="el" href="struct_h5_f_d__subfiling__config__t.html" title="Configuration structure for H5Pset_fapl_subfiling() / H5Pget_fapl_subfiling()">H5FD_subfiling_config_t</a> configuration structure for the <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> driver </p> + +</div> +</div> +<a id="a5b6cb61c4ef9e55eca8cdfec8c1039c7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5b6cb61c4ef9e55eca8cdfec8c1039c7">◆ </a></span>H5FD_SUBFILING_DEFAULT_STRIPE_COUNT</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_DEFAULT_STRIPE_COUNT   -1</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Macro for the default Subfiling stripe count value. The default is currently to use one subfile per node. </p> + +</div> +</div> +<a id="a6613027f8ed05f42be046721d40dbd56"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6613027f8ed05f42be046721d40dbd56">◆ </a></span>H5FD_SUBFILING_DEFAULT_STRIPE_SIZE</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_DEFAULT_STRIPE_SIZE   (32 * 1024 * 1024)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The default stripe size (in bytes) for data stripes in subfiles </p> + +</div> +</div> +<a id="a923120a6d3f217a8545bd654f5646cb7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a923120a6d3f217a8545bd654f5646cb7">◆ </a></span>H5FD_SUBFILING_FAPL_MAGIC</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_FAPL_MAGIC   0xFED01331</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Unique number used to distinguish the <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> driver from other HDF5 file drivers </p> + +</div> +</div> +<a id="acae2194f0e4325e41c4ab600b581e811"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acae2194f0e4325e41c4ab600b581e811">◆ </a></span>H5FD_SUBFILING_FILENAME_TEMPLATE</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_FILENAME_TEMPLATE   "%s.subfile_%" PRIu64 "_%0*d_of_%d"</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The basic template for a subfile filename. The format specifiers correspond to:</p> +<p>s -> base filename, e.g. "file.h5" PRIu64 -> file inode, e.g. 11273556 %0*d -> number (starting at 1) signifying the Nth (out of total number of subfiles) subfile. Zero-padded according to the number of digits in the number of subfiles (calculated by log10(num_subfiles) + 1) d -> number of subfiles</p> +<p>yielding filenames such as:</p> +<p>file.h5.subfile_11273556_01_of_10 file.h5.subfile_11273556_02_of_10 file.h5.subfile_11273556_10_of_10 </p> + +</div> +</div> +<a id="a5a5883d4d3c713fdbefd27971b8a67b7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5a5883d4d3c713fdbefd27971b8a67b7">◆ </a></span>H5FD_SUBFILING_IOC_PER_NODE</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_IOC_PER_NODE   "H5FD_SUBFILING_IOC_PER_NODE"</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Macro for name of the environment variable that specifies the number of MPI ranks per node to use as I/O concentrators</p> +<p>The value set for this environment variable is interpreted as a long value and must be > 0. </p> + +</div> +</div> +<a id="a8350a509d56b739b6cc8f4f1934d0e00"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8350a509d56b739b6cc8f4f1934d0e00">◆ </a></span>H5FD_SUBFILING_IOC_SELECTION_CRITERIA</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_IOC_SELECTION_CRITERIA   "H5FD_SUBFILING_IOC_SELECTION_CRITERIA"</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Macro for name of the environment variable that provides information for selection MPI ranks as I/O concentrators</p> +<p>The value set for this environment variable is interpreted differently, depending on the IOC selection method chosen.</p> +<p>For <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7a8f225a77916a61e89ac2cc94309fa16b">SELECT_IOC_ONE_PER_NODE</a>, this value is ignored.</p> +<p>For <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7ab3e4d0db99c1560e49263961850bf82e">SELECT_IOC_EVERY_NTH_RANK</a>, this value is interpreted as a long value and must be > 0. The value will correspond to the <code>N</code> value when selecting every <code>N</code>-th MPI rank as an I/O concentrator.</p> +<p>For <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7a6f9c0d42898b8e2604747189f6ee81ed">SELECT_IOC_WITH_CONFIG</a>, this value is ignored as that particular IOC selection method is not currently supported.</p> +<p>For <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7a12d13fbd9db7189a5ddcd52a2ff08d55">SELECT_IOC_TOTAL</a>, this value is interpreted as a long value and must be > 0. The value will correspond to the total number of I/O concentrators to be used. </p> + +</div> +</div> +<a id="aaa2dd4d2965df35e172a5195cadb9de2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aaa2dd4d2965df35e172a5195cadb9de2">◆ </a></span>H5FD_SUBFILING_NAME</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_NAME   "subfiling"</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The canonical name for the <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> driver </p> + +</div> +</div> +<a id="ae3da9be3aeeedafd84cca1371b6c5da4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae3da9be3aeeedafd84cca1371b6c5da4">◆ </a></span>H5FD_SUBFILING_STRIPE_SIZE</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_STRIPE_SIZE   "H5FD_SUBFILING_STRIPE_SIZE"</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Macro for name of the environment variable that specifies the size (in bytes) for data stripes in subfiles</p> +<p>The value set for this environment variable is interpreted as a long long value and must be > 0. </p> + +</div> +</div> +<a id="a837b185b9e78252d295c33c8f86e46f3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a837b185b9e78252d295c33c8f86e46f3">◆ </a></span>H5FD_SUBFILING_SUBFILE_PREFIX</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define H5FD_SUBFILING_SUBFILE_PREFIX   "H5FD_SUBFILING_SUBFILE_PREFIX"</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Macro for name of the environment variable that specifies a prefix to apply to the filenames generated for subfiles</p> +<p>The value set for this environment variable is interpreted as a pathname. </p> + +</div> +</div> +<h2 class="groupheader">Enumeration Type Documentation</h2> +<a id="a2bcf2d531a0668895308692b0c1108d7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2bcf2d531a0668895308692b0c1108d7">◆ </a></span>H5FD_subfiling_ioc_select_t</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="_h5_f_dsubfiling_8h.html#a2bcf2d531a0668895308692b0c1108d7">H5FD_subfiling_ioc_select_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>This enum defines the various constants to allow different allocations of MPI ranks as I/O concentrators. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a2bcf2d531a0668895308692b0c1108d7a8f225a77916a61e89ac2cc94309fa16b"></a>SELECT_IOC_ONE_PER_NODE </td><td class="fielddoc"><p>Default selection method. One MPI rank per node is used as an I/O concentrator. If this selection method is used, the number of I/O concentrators per node can be adjusted with the <a class="el" href="_h5_f_dsubfiling_8h.html#a5a5883d4d3c713fdbefd27971b8a67b7">H5FD_SUBFILING_IOC_PER_NODE</a> environment variable. </p> +</td></tr> +<tr><td class="fieldname"><a id="a2bcf2d531a0668895308692b0c1108d7ab3e4d0db99c1560e49263961850bf82e"></a>SELECT_IOC_EVERY_NTH_RANK </td><td class="fielddoc"><p>Starting with MPI rank 0, a stride of 'N' is applied to the MPI rank values to determine the next I/O concentrator. The <a class="el" href="_h5_f_dsubfiling_8h.html#a8350a509d56b739b6cc8f4f1934d0e00">H5FD_SUBFILING_IOC_SELECTION_CRITERIA</a> environment variable must be set to the value desired for 'N'. </p> +</td></tr> +<tr><td class="fieldname"><a id="a2bcf2d531a0668895308692b0c1108d7a6f9c0d42898b8e2604747189f6ee81ed"></a>SELECT_IOC_WITH_CONFIG </td><td class="fielddoc"><p>Currently unsupported. Use a configuration file to determine the mapping from MPI ranks to I/O concentrators. The <a class="el" href="_h5_f_dsubfiling_8h.html#a8350a509d56b739b6cc8f4f1934d0e00">H5FD_SUBFILING_IOC_SELECTION_CRITERIA</a> environment variable must be set to the path to the configuration file. </p> +</td></tr> +<tr><td class="fieldname"><a id="a2bcf2d531a0668895308692b0c1108d7a12d13fbd9db7189a5ddcd52a2ff08d55"></a>SELECT_IOC_TOTAL </td><td class="fielddoc"><p>Specifies that a total of 'N' I/O concentrators should be used. Starting with MPI rank 0, a stride of 'MPI comm size' / 'N' is applied to the MPI rank values to determine the next I/O concentrator. The <a class="el" href="_h5_f_dsubfiling_8h.html#a8350a509d56b739b6cc8f4f1934d0e00">H5FD_SUBFILING_IOC_SELECTION_CRITERIA</a> environment variable must be set to the value desired for 'N'. </p> +</td></tr> +<tr><td class="fieldname"><a id="a2bcf2d531a0668895308692b0c1108d7a3709cb22d2a065ec62e5d72057564649"></a>ioc_selection_options </td><td class="fielddoc"><p>Unused. Sentinel value </p> +</td></tr> +</table> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="ac2f254c2f4f5ca9a319584c731f2b280"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac2f254c2f4f5ca9a319584c731f2b280">◆ </a></span>H5FD_subfiling_init()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_DLL <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5FD_subfiling_init </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Internal routine to initialize <a class="el" href="_h5_f_dsubfiling_8h.html#a070ba7b51cfe718ba4da75b308066a9d">H5FD_SUBFILING</a> driver. Not meant to be called directly by an HDF5 application. </p> + +</div> +</div> +</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cecf7846bd65f3ca7010c1fa8537af78.html">H5FDsubfiling</a></li><li class="navelem"><a class="el" href="_h5_f_dsubfiling_8h.html">H5FDsubfiling.h</a></li> + <li class="footer">Generated on Mon Jun 26 2023 19:01:33 for HDF5 by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + </ul> +</div> +</body> +</html> |