libaaruformat/docs/html/structErasureCodingMapHeader.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: ErasureCodingMapHeader 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('structErasureCodingMapHeader.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">ErasureCodingMapHeader Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Header for the Erasure Coding Map Block (BlockType::ErasureCodingMapBlock).  
 <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:ac1cce17abac0be6beccb121d7a3b24b2" id="r_ac1cce17abac0be6beccb121d7a3b24b2"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#ac1cce17abac0be6beccb121d7a3b24b2">identifier</a></td></tr>
<tr class="memdesc:ac1cce17abac0be6beccb121d7a3b24b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block identifier, must be BlockType::ErasureCodingMapBlock (0x424D4345).  <br /></td></tr>
<tr class="memitem:a174d1be87a00bda3012715de76423ec4" id="r_a174d1be87a00bda3012715de76423ec4"><td class="memItemLeft">uint8_t&#160;</td><td class="memItemRight"><a class="el" href="#a174d1be87a00bda3012715de76423ec4">algorithm</a></td></tr>
<tr class="memdesc:a174d1be87a00bda3012715de76423ec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erasure coding algorithm (<a class="el" href="enums_8h.html#a83c99da65804eb80cfb955eb9a15ef5e" title="Erasure coding algorithms supported by the ECMB.">ErasureCodingAlgorithm</a>).  <br /></td></tr>
<tr class="memitem:accae80e978eeccc7c026eb5ade721aae" id="r_accae80e978eeccc7c026eb5ade721aae"><td class="memItemLeft">uint8_t&#160;</td><td class="memItemRight"><a class="el" href="#accae80e978eeccc7c026eb5ade721aae">stripeGroupCount</a></td></tr>
<tr class="memdesc:accae80e978eeccc7c026eb5ade721aae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of stripe groups in payload (typically 5).  <br /></td></tr>
<tr class="memitem:aaf860b67807c5bf871e52ae617a076ae" id="r_aaf860b67807c5bf871e52ae617a076ae"><td class="memItemLeft">uint16_t&#160;</td><td class="memItemRight"><a class="el" href="#aaf860b67807c5bf871e52ae617a076ae">compression</a></td></tr>
<tr class="memdesc:aaf860b67807c5bf871e52ae617a076ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compression algorithm for the mapping payload (<a class="el" href="enums_8h.html#affec749ed88365143745313ae9168263" title="List of known compression types.">CompressionType</a>).  <br /></td></tr>
<tr class="memitem:a2aa7763da110a8e7550e61bd6110f83d" id="r_a2aa7763da110a8e7550e61bd6110f83d"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#a2aa7763da110a8e7550e61bd6110f83d">cmpLength</a></td></tr>
<tr class="memdesc:a2aa7763da110a8e7550e61bd6110f83d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size in bytes of the compressed mapping payload.  <br /></td></tr>
<tr class="memitem:ad52f12a467a76189e31b1c01fc0e6e65" id="r_ad52f12a467a76189e31b1c01fc0e6e65"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#ad52f12a467a76189e31b1c01fc0e6e65">length</a></td></tr>
<tr class="memdesc:ad52f12a467a76189e31b1c01fc0e6e65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size in bytes of the uncompressed mapping payload.  <br /></td></tr>
<tr class="memitem:aa686c5c90093d0ba86657c1f15f64a2d" id="r_aa686c5c90093d0ba86657c1f15f64a2d"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#aa686c5c90093d0ba86657c1f15f64a2d">cmpCrc64</a></td></tr>
<tr class="memdesc:aa686c5c90093d0ba86657c1f15f64a2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA of the compressed mapping payload.  <br /></td></tr>
<tr class="memitem:aa883d1e565b1856a7a16b2fcf8ee8b7d" id="r_aa883d1e565b1856a7a16b2fcf8ee8b7d"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#aa883d1e565b1856a7a16b2fcf8ee8b7d">crc64</a></td></tr>
<tr class="memdesc:aa883d1e565b1856a7a16b2fcf8ee8b7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA of the uncompressed mapping payload.  <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header for the Erasure Coding Map Block (BlockType::ErasureCodingMapBlock). </p>
<p>The ECMB stores the master recovery map: stripe parameters and block-offset mapping for all five protection groups (data, DDT-secondary, DDT-primary, metadata, index). It is written after the index block and found via the recovery footer, NOT via the index (since the index itself may need recovery).</p>
<p>Payload (cmpLength bytes) contains an array of <a class="el" href="structStripeGroupDescriptor.html" title="Describes one protection group within the ECMB payload.">StripeGroupDescriptor</a> followed by per-stripe StripeDescriptor records, optionally compressed. </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00049">49</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="a174d1be87a00bda3012715de76423ec4" name="a174d1be87a00bda3012715de76423ec4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a174d1be87a00bda3012715de76423ec4">&#9670;&#160;</a></span>algorithm</h2>

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

<p>Erasure coding algorithm (<a class="el" href="enums_8h.html#a83c99da65804eb80cfb955eb9a15ef5e" title="Erasure coding algorithms supported by the ECMB.">ErasureCodingAlgorithm</a>). </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00052">52</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#l01046">ec_load_ecmb()</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t ErasureCodingMapHeader::cmpCrc64</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>CRC64-ECMA of the compressed mapping payload. </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00057">57</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>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t ErasureCodingMapHeader::cmpLength</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Size in bytes of the compressed mapping payload. </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00055">55</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#l01046">ec_load_ecmb()</a>.</p>

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

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

<p>Compression algorithm for the mapping payload (<a class="el" href="enums_8h.html#affec749ed88365143745313ae9168263" title="List of known compression types.">CompressionType</a>). </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00054">54</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#l01046">ec_load_ecmb()</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t ErasureCodingMapHeader::crc64</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>CRC64-ECMA of the uncompressed mapping payload. </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00058">58</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#l01046">ec_load_ecmb()</a>.</p>

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

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

<p>Block identifier, must be BlockType::ErasureCodingMapBlock (0x424D4345). </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00051">51</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#l01046">ec_load_ecmb()</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t ErasureCodingMapHeader::length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Size in bytes of the uncompressed mapping payload. </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00056">56</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#l01046">ec_load_ecmb()</a>.</p>

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

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

<p>Number of stripe groups in payload (typically 5). </p>

<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00053">53</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#l01046">ec_load_ecmb()</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="structErasureCodingMapHeader.html">ErasureCodingMapHeader</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>