libaaruformat/docs/html/structlru__kv__pair__t.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: lru_kv_pair_t Struct Reference</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('structlru__kv__pair__t.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_kv_pair_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Single key/value slot with access tracking for the static LRU hash map.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="static__lru__hash__map_8h_source.html">aaruformat/static_lru_hash_map.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:adb871f5b46397dcd1c7f1ae3010f929b" id="r_adb871f5b46397dcd1c7f1ae3010f929b"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#adb871f5b46397dcd1c7f1ae3010f929b">key</a></td></tr>
<tr class="memdesc:adb871f5b46397dcd1c7f1ae3010f929b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stored key (64-bit). 0 indicates an empty slot.  <br /></td></tr>
<tr class="memitem:ac33547a6970d9671d85d4af2cdf662ce" id="r_ac33547a6970d9671d85d4af2cdf662ce"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#ac33547a6970d9671d85d4af2cdf662ce">value</a></td></tr>
<tr class="memdesc:ac33547a6970d9671d85d4af2cdf662ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Associated value payload (64-bit).  <br /></td></tr>
<tr class="memitem:a6b149392e7cb888c1a26459de99b1075" id="r_a6b149392e7cb888c1a26459de99b1075"><td class="memItemLeft">uint8_t&#160;</td><td class="memItemRight"><a class="el" href="#a6b149392e7cb888c1a26459de99b1075">access_count</a></td></tr>
<tr class="memdesc:a6b149392e7cb888c1a26459de99b1075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access frequency counter (0-255, saturates at 255).  <br /></td></tr>
<tr class="memitem:a9a0d3d45a88d48bafab14c779ddd1f72" id="r_a9a0d3d45a88d48bafab14c779ddd1f72"><td class="memItemLeft">uint8_t&#160;</td><td class="memItemRight"><a class="el" href="#a9a0d3d45a88d48bafab14c779ddd1f72">_padding</a> [7]</td></tr>
<tr class="memdesc:a9a0d3d45a88d48bafab14c779ddd1f72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Padding for 8-byte alignment (24 bytes total per entry).  <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Single key/value slot with access tracking for the static LRU hash map. </p>
<p>Extends the basic <a class="el" href="structkv__pair__t.html" title="Single key/value slot used internally by the open-addressing hash map.">kv_pair_t</a> with an access counter to enable LFU-based eviction. The access_count saturates at 255 and is periodically aged (halved) to prevent stale "hot" entries from permanently occupying the cache.</p>
<p>An empty slot is represented by key == 0. This means 0 cannot be used as a valid key. </p>

<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00071">71</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="a9a0d3d45a88d48bafab14c779ddd1f72" name="a9a0d3d45a88d48bafab14c779ddd1f72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a0d3d45a88d48bafab14c779ddd1f72">&#9670;&#160;</a></span>_padding</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t lru_kv_pair_t::_padding[7]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Padding for 8-byte alignment (24 bytes total per entry). </p>

<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00076">76</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>

</div>
</div>
<a id="a6b149392e7cb888c1a26459de99b1075" name="a6b149392e7cb888c1a26459de99b1075"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b149392e7cb888c1a26459de99b1075">&#9670;&#160;</a></span>access_count</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t lru_kv_pair_t::access_count</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Access frequency counter (0-255, saturates at 255). </p>

<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00075">75</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00064">age_access_counts()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00139">evict_lru_entries()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00245">static_lru_insert_map()</a>, and <a class="el" href="static__lru__hash__map_8c_source.html#l00284">static_lru_lookup_map()</a>.</p>

</div>
</div>
<a id="adb871f5b46397dcd1c7f1ae3010f929b" name="adb871f5b46397dcd1c7f1ae3010f929b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb871f5b46397dcd1c7f1ae3010f929b">&#9670;&#160;</a></span>key</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t lru_kv_pair_t::key</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stored key (64-bit). 0 indicates an empty slot. </p>

<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00073">73</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00064">age_access_counts()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00139">evict_lru_entries()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00087">rehash_in_place()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00314">static_lru_contains_key()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00245">static_lru_insert_map()</a>, and <a class="el" href="static__lru__hash__map_8c_source.html#l00284">static_lru_lookup_map()</a>.</p>

</div>
</div>
<a id="ac33547a6970d9671d85d4af2cdf662ce" name="ac33547a6970d9671d85d4af2cdf662ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac33547a6970d9671d85d4af2cdf662ce">&#9670;&#160;</a></span>value</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t lru_kv_pair_t::value</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Associated value payload (64-bit). </p>

<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00074">74</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00139">evict_lru_entries()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00245">static_lru_insert_map()</a>, and <a class="el" href="static__lru__hash__map_8c_source.html#l00284">static_lru_lookup_map()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/<a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a></li>
</ul>
</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="structlru__kv__pair__t.html">lru_kv_pair_t</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>