mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
Update doxygen documentation.
This commit is contained in:
@@ -259,26 +259,26 @@ $(function(){initNavTree('ddt__v1_8c_source.html','',''); });
|
||||
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> <span class="keywordflow">break</span>;</div>
|
||||
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> <span class="comment">// TODO: Check CRC</span></div>
|
||||
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="enums_8h.html#affec749ed88365143745313ae9168263ac9d3e887722f2bc482bcca9d41c512af">None</a>:</div>
|
||||
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span><span class="preprocessor">#ifdef __linux__</span></div>
|
||||
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Memory mapping deduplication table at position %"</span> PRIu64, entry-><a class="code hl_variable" href="structIndexEntry.html#a854951a64192d7e4cdcfa6dd6fd2b3ea">offset</a> + <span class="keyword">sizeof</span>(ddt_header));</div>
|
||||
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> ctx-><a class="code hl_variable" href="structaaruformat__context.html#afc6cf8ab181536febd804d18702d4d80">mapped_memory_ddt_size</a> = <span class="keyword">sizeof</span>(uint64_t) * ddt_header.<a class="code hl_variable" href="structDdtHeader.html#a74eb3f36e0c52cc59849fcc7b283d84d">entries</a>;</div>
|
||||
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> ctx-><a class="code hl_variable" href="structaaruformat__context.html#a1d5ad658b9219c4b3838fcb042742e4e">user_data_ddt</a> = mmap(NULL, ctx-><a class="code hl_variable" href="structaaruformat__context.html#afc6cf8ab181536febd804d18702d4d80">mapped_memory_ddt_size</a>, PROT_READ, MAP_SHARED,</div>
|
||||
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> fileno(ctx-><a class="code hl_variable" href="structaaruformat__context.html#ab516fae594bde4f76b75488d0a3ca3a8">imageStream</a>), entry-><a class="code hl_variable" href="structIndexEntry.html#a854951a64192d7e4cdcfa6dd6fd2b3ea">offset</a> + <span class="keyword">sizeof</span>(ddt_header));</div>
|
||||
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> </div>
|
||||
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> <span class="keywordflow">if</span>(ctx-><a class="code hl_variable" href="structaaruformat__context.html#a1d5ad658b9219c4b3838fcb042742e4e">user_data_ddt</a> == MAP_FAILED)</div>
|
||||
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> {</div>
|
||||
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> *found_user_data_ddt = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> <a class="code hl_define" href="log_8h.html#a053d6037d543b84ce59308ce71d15cd1">FATAL</a>(<span class="stringliteral">"Could not read map deduplication table."</span>);</div>
|
||||
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <span class="keywordflow">break</span>;</div>
|
||||
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> }</div>
|
||||
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> </div>
|
||||
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> ctx-><a class="code hl_variable" href="structaaruformat__context.html#a62885cab6ef674fd27b4de32ab4ee346">in_memory_ddt</a> = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> <span class="keywordflow">break</span>;</div>
|
||||
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span><span class="preprocessor">#else </span><span class="comment">// TODO: Implement</span></div>
|
||||
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Uncompressed DDT not yet implemented..."</span>);</div>
|
||||
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> *found_user_data_ddt = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> <span class="keywordflow">break</span>;</div>
|
||||
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> ctx-><a class="code hl_variable" href="structaaruformat__context.html#a1d5ad658b9219c4b3838fcb042742e4e">user_data_ddt</a> = (uint64_t *)malloc(ddt_header.<a class="code hl_variable" href="structDdtHeader.html#a6c427b746b3fa0fd161094ba0adf3f56">length</a>);</div>
|
||||
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <span class="keywordflow">if</span>(ctx-><a class="code hl_variable" href="structaaruformat__context.html#a1d5ad658b9219c4b3838fcb042742e4e">user_data_ddt</a> == NULL)</div>
|
||||
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> {</div>
|
||||
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Cannot allocate memory for DDT, continuing..."</span>);</div>
|
||||
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> <span class="keywordflow">break</span>;</div>
|
||||
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> }</div>
|
||||
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> </div>
|
||||
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> read_bytes = fread(ctx-><a class="code hl_variable" href="structaaruformat__context.html#a1d5ad658b9219c4b3838fcb042742e4e">user_data_ddt</a>, 1, ddt_header.<a class="code hl_variable" href="structDdtHeader.html#a74eb3f36e0c52cc59849fcc7b283d84d">entries</a> * <span class="keyword">sizeof</span>(uint64_t), ctx-><a class="code hl_variable" href="structaaruformat__context.html#ab516fae594bde4f76b75488d0a3ca3a8">imageStream</a>);</div>
|
||||
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> </div>
|
||||
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> <span class="keywordflow">if</span>(read_bytes != ddt_header.<a class="code hl_variable" href="structDdtHeader.html#a74eb3f36e0c52cc59849fcc7b283d84d">entries</a> * <span class="keyword">sizeof</span>(uint64_t))</div>
|
||||
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> {</div>
|
||||
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> free(ctx-><a class="code hl_variable" href="structaaruformat__context.html#a1d5ad658b9219c4b3838fcb042742e4e">user_data_ddt</a>);</div>
|
||||
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Could not read deduplication table, continuing..."</span>);</div>
|
||||
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> <span class="keywordflow">break</span>;</div>
|
||||
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> }</div>
|
||||
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> </div>
|
||||
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> ctx-><a class="code hl_variable" href="structaaruformat__context.html#a62885cab6ef674fd27b4de32ab4ee346">in_memory_ddt</a> = <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> *found_user_data_ddt = <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> </div>
|
||||
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> <span class="keywordflow">break</span>;</div>
|
||||
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> <span class="keywordflow">default</span>:</div>
|
||||
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Found unknown compression type %d, continuing..."</span>, ddt_header.<a class="code hl_variable" href="structDdtHeader.html#a582d814208475da3a610e7773a3b2ded">compression</a>);</div>
|
||||
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span> *found_user_data_ddt = <span class="keyword">false</span>;</div>
|
||||
@@ -475,8 +475,8 @@ $(function(){initNavTree('ddt__v1_8c_source.html','',''); });
|
||||
<div class="ttc" id="astructDdtHeader_html_a683a82d49a20adf6348fbcde58e2ecd9"><div class="ttname"><a href="structDdtHeader.html#a683a82d49a20adf6348fbcde58e2ecd9">DdtHeader::cmpLength</a></div><div class="ttdeci">uint64_t cmpLength</div><div class="ttdoc">Size in bytes of compressed entries payload.</div><div class="ttdef"><b>Definition</b> <a href="ddt_8h_source.html#l00072">ddt.h:72</a></div></div>
|
||||
<div class="ttc" id="astructDdtHeader_html_a6c427b746b3fa0fd161094ba0adf3f56"><div class="ttname"><a href="structDdtHeader.html#a6c427b746b3fa0fd161094ba0adf3f56">DdtHeader::length</a></div><div class="ttdeci">uint64_t length</div><div class="ttdoc">Size in bytes of uncompressed entries payload.</div><div class="ttdef"><b>Definition</b> <a href="ddt_8h_source.html#l00073">ddt.h:73</a></div></div>
|
||||
<div class="ttc" id="astructDdtHeader_html_a74eb3f36e0c52cc59849fcc7b283d84d"><div class="ttname"><a href="structDdtHeader.html#a74eb3f36e0c52cc59849fcc7b283d84d">DdtHeader::entries</a></div><div class="ttdeci">uint64_t entries</div><div class="ttdoc">Number of deduplication entries contained in (uncompressed) table.</div><div class="ttdef"><b>Definition</b> <a href="ddt_8h_source.html#l00071">ddt.h:71</a></div></div>
|
||||
<div class="ttc" id="astructImageInfo_html_abca8e73a9655d810e6d30d36c3ab54d7"><div class="ttname"><a href="structImageInfo.html#abca8e73a9655d810e6d30d36c3ab54d7">ImageInfo::ImageSize</a></div><div class="ttdeci">uint64_t ImageSize</div><div class="ttdoc">Size of the image payload in bytes (excludes headers/metadata)</div><div class="ttdef"><b>Definition</b> <a href="aaru_8h_source.html#l00873">aaru.h:873</a></div></div>
|
||||
<div class="ttc" id="astructImageInfo_html_ae3e1b9cde1c51152b00eb1b59e199906"><div class="ttname"><a href="structImageInfo.html#ae3e1b9cde1c51152b00eb1b59e199906">ImageInfo::Sectors</a></div><div class="ttdeci">uint64_t Sectors</div><div class="ttdoc">Total count of addressable logical sectors/blocks.</div><div class="ttdef"><b>Definition</b> <a href="aaru_8h_source.html#l00874">aaru.h:874</a></div></div>
|
||||
<div class="ttc" id="astructImageInfo_html_abca8e73a9655d810e6d30d36c3ab54d7"><div class="ttname"><a href="structImageInfo.html#abca8e73a9655d810e6d30d36c3ab54d7">ImageInfo::ImageSize</a></div><div class="ttdeci">uint64_t ImageSize</div><div class="ttdoc">Size of the image payload in bytes (excludes headers/metadata)</div><div class="ttdef"><b>Definition</b> <a href="aaru_8h_source.html#l00925">aaru.h:925</a></div></div>
|
||||
<div class="ttc" id="astructImageInfo_html_ae3e1b9cde1c51152b00eb1b59e199906"><div class="ttname"><a href="structImageInfo.html#ae3e1b9cde1c51152b00eb1b59e199906">ImageInfo::Sectors</a></div><div class="ttdeci">uint64_t Sectors</div><div class="ttdoc">Total count of addressable logical sectors/blocks.</div><div class="ttdef"><b>Definition</b> <a href="aaru_8h_source.html#l00926">aaru.h:926</a></div></div>
|
||||
<div class="ttc" id="astructIndexEntry_html"><div class="ttname"><a href="structIndexEntry.html">IndexEntry</a></div><div class="ttdoc">Single index entry describing a block's type, (optional) data classification, and file offset.</div><div class="ttdef"><b>Definition</b> <a href="index_8h_source.html#l00108">index.h:109</a></div></div>
|
||||
<div class="ttc" id="astructIndexEntry_html_a854951a64192d7e4cdcfa6dd6fd2b3ea"><div class="ttname"><a href="structIndexEntry.html#a854951a64192d7e4cdcfa6dd6fd2b3ea">IndexEntry::offset</a></div><div class="ttdeci">uint64_t offset</div><div class="ttdoc">Absolute byte offset in the image where the referenced block header begins.</div><div class="ttdef"><b>Definition</b> <a href="index_8h_source.html#l00112">index.h:112</a></div></div>
|
||||
<div class="ttc" id="astructIndexEntry_html_ae5d35082a756e0388efbf5fabbe93d10"><div class="ttname"><a href="structIndexEntry.html#ae5d35082a756e0388efbf5fabbe93d10">IndexEntry::dataType</a></div><div class="ttdeci">uint16_t dataType</div><div class="ttdoc">Data classification (value from DataType) or unused for untyped blocks.</div><div class="ttdef"><b>Definition</b> <a href="index_8h_source.html#l00111">index.h:111</a></div></div>
|
||||
@@ -489,7 +489,6 @@ $(function(){initNavTree('ddt__v1_8c_source.html','',''); });
|
||||
<div class="ttc" id="astructaaruformat__context_html_ab516fae594bde4f76b75488d0a3ca3a8"><div class="ttname"><a href="structaaruformat__context.html#ab516fae594bde4f76b75488d0a3ca3a8">aaruformat_context::imageStream</a></div><div class="ttdeci">FILE * imageStream</div><div class="ttdoc">Underlying FILE* stream (binary mode).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00176">context.h:176</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_ac970291b3449c04221827b9c2c18ac70"><div class="ttname"><a href="structaaruformat__context.html#ac970291b3449c04221827b9c2c18ac70">aaruformat_context::image_info</a></div><div class="ttdeci">ImageInfo image_info</div><div class="ttdoc">Exposed high-level image info summary.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00260">context.h:260</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_ad9e40dfb41ec80b902869354b052dd7d"><div class="ttname"><a href="structaaruformat__context.html#ad9e40dfb41ec80b902869354b052dd7d">aaruformat_context::sector_prefix_ddt</a></div><div class="ttdeci">uint32_t * sector_prefix_ddt</div><div class="ttdoc">Legacy CD sector prefix DDT (deprecated by *2).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00183">context.h:183</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_afc6cf8ab181536febd804d18702d4d80"><div class="ttname"><a href="structaaruformat__context.html#afc6cf8ab181536febd804d18702d4d80">aaruformat_context::mapped_memory_ddt_size</a></div><div class="ttdeci">size_t mapped_memory_ddt_size</div><div class="ttdoc">Length of mmapped DDT if userDataDdt is mmapped.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00193">context.h:193</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
</div><!-- container -->
|
||||
|
||||
Reference in New Issue
Block a user