aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-04-21 21:49:28 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity
Files
6aa55d7e3f7df772ebfa7ec9a100e383527cfdde
libaaruformat/docs/html/lru_8h_source.html

151 lines
14 KiB
HTML
Raw Blame History

<!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: include/aaruformat/lru.h Source File</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.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('lru_8h_source.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.h</div></div>
</div><!--header-->
<div class="contents">
<a href="lru_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Created by claunia on 2/10/22.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">//</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#ifndef LIBAARUFORMAT_LRU_H</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#define LIBAARUFORMAT_LRU_H</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;uthash.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span></div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="};">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structCacheEntry.html"> 23</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structCacheEntry.html">CacheEntry</a></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>{</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structCacheEntry.html#acee4cc303db10f54cfe2314142f24428"> 25</a></span> uint64_t <a class="code hl_variable" href="structCacheEntry.html#acee4cc303db10f54cfe2314142f24428">key</a>; </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56"> 26</a></span> <span class="keywordtype">void</span> *<a class="code hl_variable" href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a>; </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structCacheEntry.html#ae7e5f03fa52b88d99e27e2433623b4f5"> 27</a></span> UT_hash_handle <a class="code hl_variable" href="structCacheEntry.html#ae7e5f03fa52b88d99e27e2433623b4f5">hh</a>; </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>};</div>
</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span></div>
<div class="foldopen" id="foldopen00041" data-start="{" data-end="};">
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="structCacheHeader.html"> 41</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>{</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structCacheHeader.html#ad3b962f8ce6c6115143cf581c7936e55"> 43</a></span> uint64_t <a class="code hl_variable" href="structCacheHeader.html#ad3b962f8ce6c6115143cf581c7936e55">max_items</a>; </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="structCacheHeader.html#a44229bb929d8949f3c2700d07123d224"> 44</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structCacheEntry.html">CacheEntry</a> *<a class="code hl_variable" href="structCacheHeader.html#a44229bb929d8949f3c2700d07123d224">cache</a>; </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structCacheHeader.html#afeac54c794f8fece845e49954fd89f1a"> 45</a></span> void (*<a class="code hl_variable" href="structCacheHeader.html#afeac54c794f8fece845e49954fd89f1a">free_func</a>)(<span class="keywordtype">void</span> *); </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>};</div>
</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keywordtype">void</span> *<a class="code hl_function" href="lru_8h.html#a8cb7ac8e057627210732ee61d2966e35">find_in_cache_uint64</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, uint64_t <a class="code hl_variable" href="structCacheEntry.html#acee4cc303db10f54cfe2314142f24428">key</a>);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keywordtype">void</span> <a class="code hl_function" href="lru_8h.html#a0735969939ca80db3fe439ed92b787bb">add_to_cache_uint64</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, uint64_t <a class="code hl_variable" href="structCacheEntry.html#acee4cc303db10f54cfe2314142f24428">key</a>, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a>);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="keywordtype">void</span> <a class="code hl_function" href="lru_8h.html#a92e298695411672c3497ae5c8d9c0427">free_cache</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_LRU_H</span></div>
<div class="ttc" id="alru_8h_html_a0735969939ca80db3fe439ed92b787bb"><div class="ttname"><a href="lru_8h.html#a0735969939ca80db3fe439ed92b787bb">add_to_cache_uint64</a></div><div class="ttdeci">void add_to_cache_uint64(struct CacheHeader *cache, uint64_t key, void *value)</div><div class="ttdoc">Adds a value to the cache with a uint64_t key, evicting LRU if full.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00048">lru.c:48</a></div></div>
<div class="ttc" id="alru_8h_html_a8cb7ac8e057627210732ee61d2966e35"><div class="ttname"><a href="lru_8h.html#a8cb7ac8e057627210732ee61d2966e35">find_in_cache_uint64</a></div><div class="ttdeci">void * find_in_cache_uint64(struct CacheHeader *cache, uint64_t key)</div><div class="ttdoc">Finds a value in the cache by uint64_t key.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00024">lru.c:24</a></div></div>
<div class="ttc" id="alru_8h_html_a92e298695411672c3497ae5c8d9c0427"><div class="ttname"><a href="lru_8h.html#a92e298695411672c3497ae5c8d9c0427">free_cache</a></div><div class="ttdeci">void free_cache(struct CacheHeader *cache)</div><div class="ttdoc">Frees all entries in the cache and clears it.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00082">lru.c:82</a></div></div>
<div class="ttc" id="astructCacheEntry_html"><div class="ttname"><a href="structCacheEntry.html">CacheEntry</a></div><div class="ttdoc">Single hash entry in the in-memory cache.</div><div class="ttdef"><b>Definition</b> <a href="#l00023">lru.h:24</a></div></div>
<div class="ttc" id="astructCacheEntry_html_a7d6d1ed0aab03cffbb34aff16f6f3d56"><div class="ttname"><a href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56">CacheEntry::value</a></div><div class="ttdeci">void * value</div><div class="ttdoc">Opaque value pointer associated with key.</div><div class="ttdef"><b>Definition</b> <a href="#l00026">lru.h:26</a></div></div>
<div class="ttc" id="astructCacheEntry_html_acee4cc303db10f54cfe2314142f24428"><div class="ttname"><a href="structCacheEntry.html#acee4cc303db10f54cfe2314142f24428">CacheEntry::key</a></div><div class="ttdeci">uint64_t key</div><div class="ttdoc">64-bit integer key (unique within the cache).</div><div class="ttdef"><b>Definition</b> <a href="#l00025">lru.h:25</a></div></div>
<div class="ttc" id="astructCacheEntry_html_ae7e5f03fa52b88d99e27e2433623b4f5"><div class="ttname"><a href="structCacheEntry.html#ae7e5f03fa52b88d99e27e2433623b4f5">CacheEntry::hh</a></div><div class="ttdeci">UT_hash_handle hh</div><div class="ttdoc">uthash handle (must remain per uthash docs).</div><div class="ttdef"><b>Definition</b> <a href="#l00027">lru.h:27</a></div></div>
<div class="ttc" id="astructCacheHeader_html"><div class="ttname"><a href="structCacheHeader.html">CacheHeader</a></div><div class="ttdoc">Cache top-level descriptor encapsulating the hash table root and capacity limit.</div><div class="ttdef"><b>Definition</b> <a href="#l00041">lru.h:42</a></div></div>
<div class="ttc" id="astructCacheHeader_html_a44229bb929d8949f3c2700d07123d224"><div class="ttname"><a href="structCacheHeader.html#a44229bb929d8949f3c2700d07123d224">CacheHeader::cache</a></div><div class="ttdeci">struct CacheEntry * cache</div><div class="ttdoc">Hash root (uthash). NULL when empty.</div><div class="ttdef"><b>Definition</b> <a href="#l00044">lru.h:44</a></div></div>
<div class="ttc" id="astructCacheHeader_html_ad3b962f8ce6c6115143cf581c7936e55"><div class="ttname"><a href="structCacheHeader.html#ad3b962f8ce6c6115143cf581c7936e55">CacheHeader::max_items</a></div><div class="ttdeci">uint64_t max_items</div><div class="ttdoc">Hard limit for number of entries.</div><div class="ttdef"><b>Definition</b> <a href="#l00043">lru.h:43</a></div></div>
<div class="ttc" id="astructCacheHeader_html_afeac54c794f8fece845e49954fd89f1a"><div class="ttname"><a href="structCacheHeader.html#afeac54c794f8fece845e49954fd89f1a">CacheHeader::free_func</a></div><div class="ttdeci">void(* free_func)(void *)</div><div class="ttdoc">Optional callback to free cached values. NULL if not needed.</div><div class="ttdef"><b>Definition</b> <a href="#l00045">lru.h:45</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</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="lru_8h.html">lru.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.16.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink