aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ced56fad6c562b5950668596c284dd0ac82cf1ce
libaaruformat/docs/html/lru_8c.html

328 lines
16 KiB
HTML
Raw Normal View History

Add doxygen documentation
2025-10-11 01:35:43 +01:00
<!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: src/lru.c 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">&#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.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('lru_8c.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">lru.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;inttypes.h&gt;</code><br />
<code>#include &lt;stddef.h&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;uthash.h&gt;</code><br />
<code>#include &lt;<a class="el" href="aaruformat_8h_source.html">aaruformat.h</a>&gt;</code><br />
</div>
<p><a href="lru_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac7008173fc7e392fa825c69410920f0a" id="r_ac7008173fc7e392fa825c69410920f0a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7008173fc7e392fa825c69410920f0a">find_in_cache</a> (struct <a class="el" href="structCacheHeader.html">CacheHeader</a> *cache, const char *key)</td></tr>
<tr class="memdesc:ac7008173fc7e392fa825c69410920f0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a value in the cache by string key. <br /></td></tr>
<tr class="memitem:a962bb6b97fb208cbd8a5932afb60e680" id="r_a962bb6b97fb208cbd8a5932afb60e680"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a962bb6b97fb208cbd8a5932afb60e680">add_to_cache</a> (struct <a class="el" href="structCacheHeader.html">CacheHeader</a> *cache, const char *key, void *value)</td></tr>
<tr class="memdesc:a962bb6b97fb208cbd8a5932afb60e680"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a value to the cache with a string key, pruning if necessary. <br /></td></tr>
<tr class="memitem:a8c8313d05785802938c6d8a2a7fa3e09" id="r_a8c8313d05785802938c6d8a2a7fa3e09"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8c8313d05785802938c6d8a2a7fa3e09">__attribute__</a> ((always_inline))</td></tr>
<tr class="memitem:af628823e6826f0d0e0aa52f96fc74f02" id="r_af628823e6826f0d0e0aa52f96fc74f02"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af628823e6826f0d0e0aa52f96fc74f02">find_in_cache_uint64</a> (struct <a class="el" href="structCacheHeader.html">CacheHeader</a> *cache, const uint64_t key)</td></tr>
<tr class="memdesc:af628823e6826f0d0e0aa52f96fc74f02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a value in the cache by uint64_t key, using string conversion. <br /></td></tr>
<tr class="memitem:a06d1782c0ae7cb53efa1b5e0f63c5ccb" id="r_a06d1782c0ae7cb53efa1b5e0f63c5ccb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a06d1782c0ae7cb53efa1b5e0f63c5ccb">add_to_cache_uint64</a> (struct <a class="el" href="structCacheHeader.html">CacheHeader</a> *cache, const uint64_t key, void *value)</td></tr>
<tr class="memdesc:a06d1782c0ae7cb53efa1b5e0f63c5ccb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a value to the cache with a uint64_t key, using string conversion. <br /></td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="a8c8313d05785802938c6d8a2a7fa3e09" name="a8c8313d05785802938c6d8a2a7fa3e09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c8313d05785802938c6d8a2a7fa3e09">&#9670;&#160;</a></span>__attribute__()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">__attribute__ </td>
<td>(</td>
<td class="paramtype">(always_inline)</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="lru_8c_source.html#l00071">71</a> of file <a class="el" href="lru_8c_source.html">lru.c</a>.</p>
<p class="reference">References <a class="el" href="decls_8h_source.html#l00063">FORCE_INLINE</a>.</p>
</div>
</div>
<a id="a962bb6b97fb208cbd8a5932afb60e680" name="a962bb6b97fb208cbd8a5932afb60e680"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a962bb6b97fb208cbd8a5932afb60e680">&#9670;&#160;</a></span>add_to_cache()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void add_to_cache </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structCacheHeader.html">CacheHeader</a> *</td> <td class="paramname"><span class="paramname"><em>cache</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>value</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a value to the cache with a string key, pruning if necessary. </p>
<p>Adds a new entry to the cache. If the cache exceeds its maximum size, prunes the least recently used entry.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>Pointer to the cache header. </td></tr>
<tr><td class="paramname">key</td><td>String key to add. </td></tr>
<tr><td class="paramname">value</td><td>Pointer to the value to store. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="lru_8c_source.html#l00047">47</a> of file <a class="el" href="lru_8c_source.html">lru.c</a>.</p>
<p class="reference">References <a class="el" href="lru_8h_source.html#l00048">CacheHeader::cache</a>, <a class="el" href="lru_8h_source.html#l00030">CacheEntry::hh</a>, <a class="el" href="lru_8h_source.html#l00028">CacheEntry::key</a>, <a class="el" href="lru_8h_source.html#l00047">CacheHeader::max_items</a>, and <a class="el" href="lru_8h_source.html#l00029">CacheEntry::value</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00102">add_to_cache_uint64()</a>.</p>
</div>
</div>
<a id="a06d1782c0ae7cb53efa1b5e0f63c5ccb" name="a06d1782c0ae7cb53efa1b5e0f63c5ccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06d1782c0ae7cb53efa1b5e0f63c5ccb">&#9670;&#160;</a></span>add_to_cache_uint64()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void add_to_cache_uint64 </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structCacheHeader.html">CacheHeader</a> *</td> <td class="paramname"><span class="paramname"><em>cache</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint64_t</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>value</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a value to the cache with a uint64_t key, using string conversion. </p>
<p>Converts the uint64_t key to a string and adds the entry to the cache.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>Pointer to the cache header. </td></tr>
<tr><td class="paramname">key</td><td>64-bit integer key to add. </td></tr>
<tr><td class="paramname">value</td><td>Pointer to the value to store. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="lru_8c_source.html#l00102">102</a> of file <a class="el" href="lru_8c_source.html">lru.c</a>.</p>
<p class="reference">References <a class="el" href="lru_8c_source.html#l00047">add_to_cache()</a>, <a class="el" href="lru_8h_source.html#l00028">CacheEntry::key</a>, and <a class="el" href="lru_8h_source.html#l00029">CacheEntry::value</a>.</p>
Update doxygen documentation.
2025-10-11 12:43:39 +01:00
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="ac7008173fc7e392fa825c69410920f0a" name="ac7008173fc7e392fa825c69410920f0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7008173fc7e392fa825c69410920f0a">&#9670;&#160;</a></span>find_in_cache()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * find_in_cache </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structCacheHeader.html">CacheHeader</a> *</td> <td class="paramname"><span class="paramname"><em>cache</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>key</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds a value in the cache by string key. </p>
<p>Searches for a value in the cache using a string key and moves it to the front if found.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>Pointer to the cache header. </td></tr>
<tr><td class="paramname">key</td><td>String key to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the value if found, or NULL if not found. </dd></dl>
<p class="definition">Definition at line <a class="el" href="lru_8c_source.html#l00024">24</a> of file <a class="el" href="lru_8c_source.html">lru.c</a>.</p>
<p class="reference">References <a class="el" href="lru_8h_source.html#l00048">CacheHeader::cache</a>, <a class="el" href="lru_8h_source.html#l00030">CacheEntry::hh</a>, <a class="el" href="lru_8h_source.html#l00028">CacheEntry::key</a>, and <a class="el" href="lru_8h_source.html#l00029">CacheEntry::value</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00088">find_in_cache_uint64()</a>.</p>
</div>
</div>
<a id="af628823e6826f0d0e0aa52f96fc74f02" name="af628823e6826f0d0e0aa52f96fc74f02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af628823e6826f0d0e0aa52f96fc74f02">&#9670;&#160;</a></span>find_in_cache_uint64()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * find_in_cache_uint64 </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structCacheHeader.html">CacheHeader</a> *</td> <td class="paramname"><span class="paramname"><em>cache</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint64_t</td> <td class="paramname"><span class="paramname"><em>key</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds a value in the cache by uint64_t key, using string conversion. </p>
<p>Converts the uint64_t key to a string and searches for the entry in the cache.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>Pointer to the cache header. </td></tr>
<tr><td class="paramname">key</td><td>64-bit integer key to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the value if found, or NULL if not found. </dd></dl>
<p class="definition">Definition at line <a class="el" href="lru_8c_source.html#l00088">88</a> of file <a class="el" href="lru_8c_source.html">lru.c</a>.</p>
<p class="reference">References <a class="el" href="lru_8c_source.html#l00024">find_in_cache()</a>, and <a class="el" href="lru_8h_source.html#l00028">CacheEntry::key</a>.</p>
Update doxygen documentation.
2025-10-11 12:43:39 +01:00
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a href="lru_8c.html">lru.c</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>
Reference in New Issue Copy Permalink