libaaruformat/docs/html/structStripeGroupDescriptor.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.18.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: StripeGroupDescriptor Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="codefolding.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">libaaruformat<span id="projectnumber">&#160;1.0</span>
   </div>
   <div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.18.0 -->
<script type="text/javascript">
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="application/json" id="doxygen-config">
{
  "relPath": "",
  "generateTreeView": true,
  "searchEngine": true,
  "serverBasedSearch": false,
  "disableIndex": false,
  "dynamicMenus": true,
  "fullSidebar": false
}
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<div id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
  <ul class="sm sm-dox" id="main-menu">
    <li id="searchBoxPos2">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
          </span>
        </div>
    </li>
  </ul>
</div><!-- main-nav -->
</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" class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded',() => { initNavTree('structStripeGroupDescriptor.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow">
</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="headertitle"><div class="title">StripeGroupDescriptor Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Describes one protection group within the ECMB payload.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="erasure_8h_source.html">aaruformat/structs/erasure.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a6093f8c41fb1aa55c8367e2a92fe9f7f" id="r_a6093f8c41fb1aa55c8367e2a92fe9f7f"><td class="memItemLeft">uint8_t&#160;</td><td class="memItemRight"><a class="el" href="#a6093f8c41fb1aa55c8367e2a92fe9f7f">groupType</a></td></tr>
<tr class="memdesc:a6093f8c41fb1aa55c8367e2a92fe9f7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protection group type (<a class="el" href="enums_8h.html#a485c1f7093f3c3171ac27404bfb1b03e" title="Identifies which protection group a stripe belongs to.">ErasureCodingGroupType</a>).  <br /></td></tr>
<tr class="memitem:a46b938eb0fea65843e741c2cc240d14b" id="r_a46b938eb0fea65843e741c2cc240d14b"><td class="memItemLeft">uint16_t&#160;</td><td class="memItemRight"><a class="el" href="#a46b938eb0fea65843e741c2cc240d14b">K</a></td></tr>
<tr class="memdesc:a46b938eb0fea65843e741c2cc240d14b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of data blocks per stripe.  <br /></td></tr>
<tr class="memitem:afd47dcff7fe194084c22dab9a6866c8b" id="r_afd47dcff7fe194084c22dab9a6866c8b"><td class="memItemLeft">uint16_t&#160;</td><td class="memItemRight"><a class="el" href="#afd47dcff7fe194084c22dab9a6866c8b">M</a></td></tr>
<tr class="memdesc:afd47dcff7fe194084c22dab9a6866c8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of parity blocks per stripe.  <br /></td></tr>
<tr class="memitem:a2a457b42f8562c872b0b7e0f1b054ef5" id="r_a2a457b42f8562c872b0b7e0f1b054ef5"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a2a457b42f8562c872b0b7e0f1b054ef5">shardSize</a></td></tr>
<tr class="memdesc:a2a457b42f8562c872b0b7e0f1b054ef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fixed shard size in bytes (max possible on-disk block size for this group).  <br /></td></tr>
<tr class="memitem:a9b737c4f6fda1894d51858d2a3d8d877" id="r_a9b737c4f6fda1894d51858d2a3d8d877"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a9b737c4f6fda1894d51858d2a3d8d877">stripeCount</a></td></tr>
<tr class="memdesc:a9b737c4f6fda1894d51858d2a3d8d877"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of stripes in this group.  <br /></td></tr>
<tr class="memitem:a747366878bf9d2d68b37fddc30346546" id="r_a747366878bf9d2d68b37fddc30346546"><td class="memItemLeft">uint16_t&#160;</td><td class="memItemRight"><a class="el" href="#a747366878bf9d2d68b37fddc30346546">interleaveDepth</a></td></tr>
<tr class="memdesc:a747366878bf9d2d68b37fddc30346546"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interleave depth D (K for full interleave, 1 for consecutive).  <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes one protection group within the ECMB payload. </p>
<p>Each group has its own K, M, shard size, and interleave depth. Followed by stripeCount StripeDescriptor records. </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00068">68</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="a6093f8c41fb1aa55c8367e2a92fe9f7f" name="a6093f8c41fb1aa55c8367e2a92fe9f7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6093f8c41fb1aa55c8367e2a92fe9f7f">&#9670;&#160;</a></span>groupType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t StripeGroupDescriptor::groupType</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Protection group type (<a class="el" href="enums_8h.html#a485c1f7093f3c3171ac27404bfb1b03e" title="Identifies which protection group a stripe belongs to.">ErasureCodingGroupType</a>). </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00070">70</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="erasure_8c_source.html#l00585">ec_finalize()</a>, <a class="el" href="erasure_8c_source.html#l01046">ec_load_ecmb()</a>, and <a class="el" href="erasure_8c_source.html#l00439">ec_write_batch_parity()</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t StripeGroupDescriptor::interleaveDepth</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Interleave depth D (K for full interleave, 1 for consecutive). </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00075">75</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="erasure_8c_source.html#l00585">ec_finalize()</a>, and <a class="el" href="erasure_8c_source.html#l00439">ec_write_batch_parity()</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t StripeGroupDescriptor::K</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of data blocks per stripe. </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00071">71</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="erasure_8c_source.html#l00585">ec_finalize()</a>, <a class="el" href="erasure_8c_source.html#l01046">ec_load_ecmb()</a>, and <a class="el" href="erasure_8c_source.html#l00439">ec_write_batch_parity()</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t StripeGroupDescriptor::M</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of parity blocks per stripe. </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00072">72</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="erasure_8c_source.html#l00585">ec_finalize()</a>, <a class="el" href="erasure_8c_source.html#l01046">ec_load_ecmb()</a>, and <a class="el" href="erasure_8c_source.html#l00439">ec_write_batch_parity()</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t StripeGroupDescriptor::shardSize</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Fixed shard size in bytes (max possible on-disk block size for this group). </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00073">73</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="erasure_8c_source.html#l00585">ec_finalize()</a>, <a class="el" href="erasure_8c_source.html#l01046">ec_load_ecmb()</a>, and <a class="el" href="erasure_8c_source.html#l00439">ec_write_batch_parity()</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t StripeGroupDescriptor::stripeCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of stripes in this group. </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00074">74</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="erasure_8c_source.html#l00585">ec_finalize()</a>, <a class="el" href="erasure_8c_source.html#l01046">ec_load_ecmb()</a>, and <a class="el" href="erasure_8c_source.html#l00439">ec_write_batch_parity()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/structs/<a class="el" href="erasure_8h_source.html">erasure.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a href="structStripeGroupDescriptor.html">StripeGroupDescriptor</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.18.0 </li>
  </ul>
</div>
</body>
</html>