mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2026-04-20 13:03:27 +00:00
248 lines
13 KiB
HTML
248 lines
13 KiB
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.16.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libaaruformat: AaruRecoveryFooter 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>
|
|
<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"> 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.16.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</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">
|
|
$(function(){initNavTree('structAaruRecoveryFooter.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<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="headertitle"><div class="title">AaruRecoveryFooter Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Recovery footer written at the very end of the file (last 160 bytes).
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="erasure_8h_source.html">aaruformat/structs/erasure.h</a>></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:a67e4601f7be9a5f7e84cb3adfb98e68a" id="r_a67e4601f7be9a5f7e84cb3adfb98e68a"><td class="memItemLeft">uint64_t </td><td class="memItemRight"><a class="el" href="#a67e4601f7be9a5f7e84cb3adfb98e68a">ecmbOffset</a></td></tr>
|
|
<tr class="memdesc:a67e4601f7be9a5f7e84cb3adfb98e68a"><td class="mdescLeft"> </td><td class="mdescRight">Absolute file offset of the primary ECMB. <br /></td></tr>
|
|
<tr class="memitem:ad3f4ad3842317379eea5ad1bd3335482" id="r_ad3f4ad3842317379eea5ad1bd3335482"><td class="memItemLeft">uint64_t </td><td class="memItemRight"><a class="el" href="#ad3f4ad3842317379eea5ad1bd3335482">ecmbLength</a></td></tr>
|
|
<tr class="memdesc:ad3f4ad3842317379eea5ad1bd3335482"><td class="mdescLeft"> </td><td class="mdescRight">Total on-disk size of the ECMB (header + payload). <br /></td></tr>
|
|
<tr class="memitem:a2a0e7425f369422c197cda6b4ff56033" id="r_a2a0e7425f369422c197cda6b4ff56033"><td class="memItemLeft">uint64_t </td><td class="memItemRight"><a class="el" href="#a2a0e7425f369422c197cda6b4ff56033">headerCrc64</a></td></tr>
|
|
<tr class="memdesc:a2a0e7425f369422c197cda6b4ff56033"><td class="mdescLeft"> </td><td class="mdescRight">CRC64-ECMA of the original <a class="el" href="structAaruHeaderV2.html" title="Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps.">AaruHeaderV2</a> (128 bytes at offset 0). <br /></td></tr>
|
|
<tr class="memitem:afd53d818d8d4f4c23e4483bfea1701f5" id="r_afd53d818d8d4f4c23e4483bfea1701f5"><td class="memItemLeft"><a class="el" href="structAaruHeaderV2.html">AaruHeaderV2</a> </td><td class="memItemRight"><a class="el" href="#afd53d818d8d4f4c23e4483bfea1701f5">backupHeader</a></td></tr>
|
|
<tr class="memdesc:afd53d818d8d4f4c23e4483bfea1701f5"><td class="mdescLeft"> </td><td class="mdescRight">Complete copy of <a class="el" href="structAaruHeaderV2.html" title="Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps.">AaruHeaderV2</a> from file offset 0. <br /></td></tr>
|
|
<tr class="memitem:a8d65cec53b91b52d2bafb7e76eef818a" id="r_a8d65cec53b91b52d2bafb7e76eef818a"><td class="memItemLeft">uint64_t </td><td class="memItemRight"><a class="el" href="#a8d65cec53b91b52d2bafb7e76eef818a">footerMagic</a></td></tr>
|
|
<tr class="memdesc:a8d65cec53b91b52d2bafb7e76eef818a"><td class="mdescLeft"> </td><td class="mdescRight">Must be AARU_RECOVERY_FOOTER_MAGIC (0x52464D4345525641). <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Recovery footer written at the very end of the file (last 160 bytes). </p>
|
|
<p>Enables locating the ECMB and recovering from a corrupted header or index. Found by reading the last 160 bytes of the file and checking footerMagic.</p>
|
|
<p>Recovery chain:</p><ul>
|
|
<li>Normal: header -> indexOffset -> index -> ECMB (via ecmbOffset)</li>
|
|
<li>Header corrupt: footer backupHeader -> indexOffset -> index -> ECMB</li>
|
|
<li>Index corrupt: footer ecmbOffset -> ECMB -> index parity -> reconstruct</li>
|
|
<li>ECMB corrupt: duplicate ECMB at ecmbOffset + ecmbLength (aligned) </li>
|
|
</ul>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00116">116</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="afd53d818d8d4f4c23e4483bfea1701f5" name="afd53d818d8d4f4c23e4483bfea1701f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd53d818d8d4f4c23e4483bfea1701f5">◆ </a></span>backupHeader</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structAaruHeaderV2.html">AaruHeaderV2</a> AaruRecoveryFooter::backupHeader</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Complete copy of <a class="el" href="structAaruHeaderV2.html" title="Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps.">AaruHeaderV2</a> from file offset 0. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00121">121</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="open_8c_source.html#l00236">aaruf_open()</a>, and <a class="el" href="erasure_8c_source.html#l00690">ec_finalize()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad3f4ad3842317379eea5ad1bd3335482" name="ad3f4ad3842317379eea5ad1bd3335482"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3f4ad3842317379eea5ad1bd3335482">◆ </a></span>ecmbLength</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint64_t AaruRecoveryFooter::ecmbLength</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Total on-disk size of the ECMB (header + payload). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00119">119</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#l00690">ec_finalize()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a67e4601f7be9a5f7e84cb3adfb98e68a" name="a67e4601f7be9a5f7e84cb3adfb98e68a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67e4601f7be9a5f7e84cb3adfb98e68a">◆ </a></span>ecmbOffset</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint64_t AaruRecoveryFooter::ecmbOffset</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Absolute file offset of the primary ECMB. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00118">118</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#l00690">ec_finalize()</a>, and <a class="el" href="erasure_8c_source.html#l00941">ec_load_ecmb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d65cec53b91b52d2bafb7e76eef818a" name="a8d65cec53b91b52d2bafb7e76eef818a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d65cec53b91b52d2bafb7e76eef818a">◆ </a></span>footerMagic</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint64_t AaruRecoveryFooter::footerMagic</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Must be AARU_RECOVERY_FOOTER_MAGIC (0x52464D4345525641). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00122">122</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="open_8c_source.html#l00236">aaruf_open()</a>, <a class="el" href="erasure_8c_source.html#l00690">ec_finalize()</a>, and <a class="el" href="erasure_8c_source.html#l00941">ec_load_ecmb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2a0e7425f369422c197cda6b4ff56033" name="a2a0e7425f369422c197cda6b4ff56033"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2a0e7425f369422c197cda6b4ff56033">◆ </a></span>headerCrc64</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint64_t AaruRecoveryFooter::headerCrc64</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>CRC64-ECMA of the original <a class="el" href="structAaruHeaderV2.html" title="Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps.">AaruHeaderV2</a> (128 bytes at offset 0). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="erasure_8h_source.html#l00120">120</a> of file <a class="el" href="erasure_8h_source.html">erasure.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="open_8c_source.html#l00236">aaruf_open()</a>, and <a class="el" href="erasure_8c_source.html#l00690">ec_finalize()</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="structAaruRecoveryFooter.html">AaruRecoveryFooter</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.16.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|