libaaruformat/docs/html/lru_8h_source.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.18.0"/>
<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="dynsections.js"></script>
<script type="text/javascript" src="codefolding.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.18.0 -->
<script type="text/javascript">
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="application/json" id="doxygen-config">
{
  "relPath": "",
  "generateTreeView": true,
  "searchEngine": true,
  "serverBasedSearch": false,
  "disableIndex": false,
  "dynamicMenus": true,
  "fullSidebar": false
}
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<div id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
  <ul class="sm sm-dox" id="main-menu">
    <li id="searchBoxPos2">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
          </span>
        </div>
    </li>
  </ul>
</div><!-- main-nav -->
</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" class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded',() => { initNavTree('lru_8h_source.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow">
</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;stddef.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &lt;uthash.h&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span></div>
<div class="foldopen" id="foldopen00024" data-start="{" data-end="};">
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="structCacheEntry.html">   24</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structCacheEntry.html">CacheEntry</a></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>{</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structCacheEntry.html#acee4cc303db10f54cfe2314142f24428">   26</a></span>    uint64_t       <a class="code hl_variable" href="structCacheEntry.html#acee4cc303db10f54cfe2314142f24428">key</a>;    </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56">   27</a></span>    <span class="keywordtype">void</span>          *<a class="code hl_variable" href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a>;  </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="structCacheEntry.html#ab7bea8f5ce4dc7ace006ccabd45a0d1f">   28</a></span>    <span class="keywordtype">size_t</span>         <a class="code hl_variable" href="structCacheEntry.html#ab7bea8f5ce4dc7ace006ccabd45a0d1f">size</a>;   </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="structCacheEntry.html#ae7e5f03fa52b88d99e27e2433623b4f5">   29</a></span>    UT_hash_handle <a class="code hl_variable" href="structCacheEntry.html#ae7e5f03fa52b88d99e27e2433623b4f5">hh</a>;     </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>};</div>
</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span></div>
<div class="foldopen" id="foldopen00050" data-start="{" data-end="};">
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structCacheHeader.html">   50</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a></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"><a class="line" href="structCacheHeader.html#af82718ebf5e59a398bc6e9428a389bb2">   52</a></span>    uint64_t <a class="code hl_variable" href="structCacheHeader.html#af82718ebf5e59a398bc6e9428a389bb2">max_bytes</a>;         </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structCacheHeader.html#ae6521ccf8e75b0c9c70297af637b1eaa">   53</a></span>    uint64_t <a class="code hl_variable" href="structCacheHeader.html#ae6521ccf8e75b0c9c70297af637b1eaa">cur_bytes</a>;         </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="structCacheHeader.html#a44229bb929d8949f3c2700d07123d224">   54</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="l00055" name="l00055"></a><span class="lineno"><a class="line" href="structCacheHeader.html#a54d553e78f5d90cce34ee684829a410f">   55</a></span>    void (*<a class="code hl_variable" href="structCacheHeader.html#a54d553e78f5d90cce34ee684829a410f">free_func</a>)(<span class="keywordtype">void</span> *);  </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>};</div>
</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</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="l00059" name="l00059"></a><span class="lineno">   59</span><span class="keywordtype">void</span>  <a class="code hl_function" href="lru_8h.html#a4c0693df23b76b54750218753a748223">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>, <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structCacheEntry.html#ab7bea8f5ce4dc7ace006ccabd45a0d1f">size</a>);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</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="l00061" name="l00061"></a><span class="lineno">   61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="preprocessor">#endif  </span><span class="comment">// LIBAARUFORMAT_LRU_H</span></div>
<div class="ttc" id="alru_8h_html_a4c0693df23b76b54750218753a748223"><div class="ttname"><a href="lru_8h.html#a4c0693df23b76b54750218753a748223">add_to_cache_uint64</a></div><div class="ttdeci">void add_to_cache_uint64(struct CacheHeader *cache, uint64_t key, void *value, size_t size)</div><div class="ttdoc">Adds a value to the cache with a uint64_t key, evicting LRU entries if over budget.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00068">lru.c:68</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#l00041">lru.c:41</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#l00118">lru.c:118</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="#l00024">lru.h:25</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="#l00027">lru.h:27</a></div></div>
<div class="ttc" id="astructCacheEntry_html_ab7bea8f5ce4dc7ace006ccabd45a0d1f"><div class="ttname"><a href="structCacheEntry.html#ab7bea8f5ce4dc7ace006ccabd45a0d1f">CacheEntry::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Size in bytes of the memory pointed to by value.</div><div class="ttdef"><b>Definition</b> <a href="#l00028">lru.h:28</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="#l00026">lru.h:26</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="#l00029">lru.h:29</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="#l00050">lru.h:51</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="#l00054">lru.h:54</a></div></div>
<div class="ttc" id="astructCacheHeader_html_a54d553e78f5d90cce34ee684829a410f"><div class="ttname"><a href="structCacheHeader.html#a54d553e78f5d90cce34ee684829a410f">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="#l00055">lru.h:55</a></div></div>
<div class="ttc" id="astructCacheHeader_html_ae6521ccf8e75b0c9c70297af637b1eaa"><div class="ttname"><a href="structCacheHeader.html#ae6521ccf8e75b0c9c70297af637b1eaa">CacheHeader::cur_bytes</a></div><div class="ttdeci">uint64_t cur_bytes</div><div class="ttdoc">Bytes currently held by the cached values.</div><div class="ttdef"><b>Definition</b> <a href="#l00053">lru.h:53</a></div></div>
<div class="ttc" id="astructCacheHeader_html_af82718ebf5e59a398bc6e9428a389bb2"><div class="ttname"><a href="structCacheHeader.html#af82718ebf5e59a398bc6e9428a389bb2">CacheHeader::max_bytes</a></div><div class="ttdeci">uint64_t max_bytes</div><div class="ttdoc">Memory budget in bytes for the cached values. 0 means unlimited.</div><div class="ttdef"><b>Definition</b> <a href="#l00052">lru.h:52</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.18.0 </li>
  </ul>
</div>
</body>
</html>