mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
230 lines
13 KiB
HTML
230 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.14.0"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>libaaruformat: include/aaruformat/crc64.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>
|
||
|
|
<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.14.0 -->
|
||
|
|
<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('crc64_8h.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">crc64.h File Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>CRC64 (ECMA-182) core context and precomputed slicing-by-4 tables.
|
||
|
|
<a href="#details">More...</a></p>
|
||
|
|
<div class="textblock"><code>#include <stdint.h></code><br />
|
||
|
|
</div>
|
||
|
|
<p><a href="crc64_8h_source.html">Go to the source code of this file.</a></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
||
|
|
Data Structures</h2></td></tr>
|
||
|
|
<tr class="memitem:crc64_5Fctx" id="r_crc64_5Fctx"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrc64__ctx.html">crc64_ctx</a></td></tr>
|
||
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Minimal ECMA-182 CRC64 incremental state container (running value only). <a href="structcrc64__ctx.html#details">More...</a><br /></td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a>
|
||
|
|
Macros</h2></td></tr>
|
||
|
|
<tr class="memitem:a4239d5693b3807b04cd1d3d5b173e9df" id="r_a4239d5693b3807b04cd1d3d5b173e9df"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4239d5693b3807b04cd1d3d5b173e9df">CRC64_ECMA_POLY</a>   0xC96C5795D7870F42ULL</td></tr>
|
||
|
|
<tr class="memdesc:a4239d5693b3807b04cd1d3d5b173e9df"><td class="mdescLeft"> </td><td class="mdescRight">ECMA-182 reflected polynomial constant. <br /></td></tr>
|
||
|
|
<tr class="memitem:ad72070c1e0954a95d3d8d3eb49e4ca06" id="r_ad72070c1e0954a95d3d8d3eb49e4ca06"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad72070c1e0954a95d3d8d3eb49e4ca06">CRC64_ECMA_SEED</a>   0xFFFFFFFFFFFFFFFFULL</td></tr>
|
||
|
|
<tr class="memdesc:ad72070c1e0954a95d3d8d3eb49e4ca06"><td class="mdescLeft"> </td><td class="mdescRight">ECMA-182 initial seed (all bits set). <br /></td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 id="header-var-members" class="groupheader"><a id="var-members" name="var-members"></a>
|
||
|
|
Variables</h2></td></tr>
|
||
|
|
<tr class="memitem:ac74d5f4eb89e0a1366aed271f46b6302" id="r_ac74d5f4eb89e0a1366aed271f46b6302"><td class="memItemLeft" align="right" valign="top">static const uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac74d5f4eb89e0a1366aed271f46b6302">crc64_table</a> [4][256]</td></tr>
|
||
|
|
<tr class="memdesc:ac74d5f4eb89e0a1366aed271f46b6302"><td class="mdescLeft"> </td><td class="mdescRight">Precomputed slicing-by-4 ECMA-182 CRC64 lookup tables (4 * 256 * 8 = 8192 bytes). <br /></td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>CRC64 (ECMA-182) core context and precomputed slicing-by-4 tables. </p>
|
||
|
|
<p>Exposes:</p><ul>
|
||
|
|
<li>crc64_ctx: minimal incremental state (initialize crc to CRC64_ECMA_SEED).</li>
|
||
|
|
<li>crc64_table[4][256]: 4-way (slicing-by-4) lookup tables for high-throughput updates.</li>
|
||
|
|
<li>CRC64_ECMA_POLY / CRC64_ECMA_SEED macros matching ECMA-182 (reflected polynomial, all-bits-set seed).</li>
|
||
|
|
</ul>
|
||
|
|
<p>Algorithm characteristics:</p><ul>
|
||
|
|
<li>Polynomial: 0xC96C5795D7870F42 (reflected form).</li>
|
||
|
|
<li>Seed / initial value: 0xFFFFFFFFFFFFFFFFULL.</li>
|
||
|
|
<li>Final XOR: none (raw accumulator is the result).</li>
|
||
|
|
<li>Bit order: reflected; least significant bit processed first.</li>
|
||
|
|
</ul>
|
||
|
|
<p>Table layout & optimization: Four 256-entry tables are used (slicing-by-4) allowing 4-byte chunks to be folded per iteration, reducing data dependency chains compared to a single-table approach. This improves throughput on modern CPUs with abundant ILP.</p>
|
||
|
|
<p>Incremental usage (pseudo-code): </p><div class="fragment"><div class="line"><a class="code hl_struct" href="structcrc64__ctx.html">crc64_ctx</a> ctx = { .crc = <a class="code hl_define" href="#ad72070c1e0954a95d3d8d3eb49e4ca06">CRC64_ECMA_SEED</a> };</div>
|
||
|
|
<div class="line">ctx.<a class="code hl_variable" href="structcrc64__ctx.html#a54b4ffe58fb5840ef43487728a1349a8">crc</a> = crc64_update(ctx.<a class="code hl_variable" href="structcrc64__ctx.html#a54b4ffe58fb5840ef43487728a1349a8">crc</a>, buf, len); <span class="comment">// internal helper using crc64_table</span></div>
|
||
|
|
<div class="line"><span class="comment">// ctx.crc now holds ECMA-182 CRC64 value.</span></div>
|
||
|
|
<div class="ttc" id="acrc64_8h_html_ad72070c1e0954a95d3d8d3eb49e4ca06"><div class="ttname"><a href="#ad72070c1e0954a95d3d8d3eb49e4ca06">CRC64_ECMA_SEED</a></div><div class="ttdeci">#define CRC64_ECMA_SEED</div><div class="ttdoc">ECMA-182 initial seed (all bits set).</div><div class="ttdef"><b>Definition</b> <a href="crc64_8h_source.html#l00280">crc64.h:280</a></div></div>
|
||
|
|
<div class="ttc" id="astructcrc64__ctx_html"><div class="ttname"><a href="structcrc64__ctx.html">crc64_ctx</a></div><div class="ttdoc">Minimal ECMA-182 CRC64 incremental state container (running value only).</div><div class="ttdef"><b>Definition</b> <a href="crc64_8h_source.html#l00055">crc64.h:56</a></div></div>
|
||
|
|
<div class="ttc" id="astructcrc64__ctx_html_a54b4ffe58fb5840ef43487728a1349a8"><div class="ttname"><a href="structcrc64__ctx.html#a54b4ffe58fb5840ef43487728a1349a8">crc64_ctx::crc</a></div><div class="ttdeci">uint64_t crc</div><div class="ttdoc">Running CRC value (initialize to CRC64_ECMA_SEED before first update).</div><div class="ttdef"><b>Definition</b> <a href="crc64_8h_source.html#l00057">crc64.h:57</a></div></div>
|
||
|
|
</div><!-- fragment --><p>Thread safety: The table is read-only; each thread must use its own <a class="el" href="structcrc64__ctx.html" title="Minimal ECMA-182 CRC64 incremental state container (running value only).">crc64_ctx</a>. Endianness: Table values are host-endian 64-bit constants; algorithm result is endianness-agnostic. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition in file <a class="el" href="crc64_8h_source.html">crc64.h</a>.</p>
|
||
|
|
</div><a name="doc-define-members" id="doc-define-members"></a><h2 id="header-doc-define-members" class="groupheader">Macro Definition Documentation</h2>
|
||
|
|
<a id="a4239d5693b3807b04cd1d3d5b173e9df" name="a4239d5693b3807b04cd1d3d5b173e9df"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4239d5693b3807b04cd1d3d5b173e9df">◆ </a></span>CRC64_ECMA_POLY</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define CRC64_ECMA_POLY   0xC96C5795D7870F42ULL</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>ECMA-182 reflected polynomial constant. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="crc64_8h_source.html#l00278">278</a> of file <a class="el" href="crc64_8h_source.html">crc64.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ad72070c1e0954a95d3d8d3eb49e4ca06" name="ad72070c1e0954a95d3d8d3eb49e4ca06"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad72070c1e0954a95d3d8d3eb49e4ca06">◆ </a></span>CRC64_ECMA_SEED</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define CRC64_ECMA_SEED   0xFFFFFFFFFFFFFFFFULL</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>ECMA-182 initial seed (all bits set). </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="crc64_8h_source.html#l00280">280</a> of file <a class="el" href="crc64_8h_source.html">crc64.h</a>.</p>
|
||
|
|
|
||
|
|
<p class="reference">Referenced by <a class="el" href="crc64_8c_source.html#l00141">aaruf_crc64_final()</a>, and <a class="el" href="crc64_8c_source.html#l00032">aaruf_crc64_init()</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a name="doc-var-members" id="doc-var-members"></a><h2 id="header-doc-var-members" class="groupheader">Variable Documentation</h2>
|
||
|
|
<a id="ac74d5f4eb89e0a1366aed271f46b6302" name="ac74d5f4eb89e0a1366aed271f46b6302"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac74d5f4eb89e0a1366aed271f46b6302">◆ </a></span>crc64_table</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint64_t crc64_table[4][256]</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Precomputed slicing-by-4 ECMA-182 CRC64 lookup tables (4 * 256 * 8 = 8192 bytes). </p>
|
||
|
|
<p>Each row corresponds to one byte lane in a 4-byte block update; actual folding logic resides in the implementation. Content generated offline; do not modify manually. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="crc64_8h_source.html#l00066">66</a> of file <a class="el" href="crc64_8h_source.html">crc64.h</a>.</p>
|
||
|
|
|
||
|
|
<p class="reference">Referenced by <a class="el" href="crc64_8c_source.html#l00102">aaruf_crc64_slicing()</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="crc64_8h.html">crc64.h</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.14.0 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|