209 lines
18 KiB
HTML
209 lines
18 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.15.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>L4Re Operating System Framework: l4/cxx/lock_guard.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>
|
|
<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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="l4re-awesome.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 style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">L4Re Operating System Framework
|
|
</div>
|
|
<div id="projectbrief">Interface and Usage Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.15.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('lock__guard_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">lock_guard.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="lock__guard_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">// vim:set ft=cpp: -*- Mode: C++ -*-</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (C) 2025 Kernkonzept GmbH.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Author(s): Martin Decky <martin.decky@kernkonzept.com></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include <pthread.h></span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include <stdlib.h></span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4.html">L4</a> {</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span></div>
|
|
<div class="foldopen" id="foldopen00044" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classL4_1_1Lock__guard.html"> 44</a></span><span class="keyword">class </span>Lock_guard</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>{</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> Lock_guard() = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> Lock_guard(<span class="keyword">const</span> Lock_guard &) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> Lock_guard &operator=(<span class="keyword">const</span> Lock_guard &) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span></div>
|
|
<div class="foldopen" id="foldopen00059" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classL4_1_1Lock__guard.html#a39dc4304fc0e663c3992d7985f2527b8"> 59</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classL4_1_1Lock__guard.html#a39dc4304fc0e663c3992d7985f2527b8">Lock_guard</a>(pthread_mutex_t &lock) : _lock(&lock)</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> {</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> _status = pthread_mutex_lock(_lock);</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span></div>
|
|
<div class="foldopen" id="foldopen00071" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classL4_1_1Lock__guard.html#a123c051b051fc44443dba6d5c6abf389"> 71</a></span> <a class="code hl_function" href="classL4_1_1Lock__guard.html#a123c051b051fc44443dba6d5c6abf389">Lock_guard</a>(Lock_guard &&guard) : _lock(guard._lock), _status(guard._status)</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> {</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> guard.release();</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span></div>
|
|
<div class="foldopen" id="foldopen00090" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classL4_1_1Lock__guard.html#a86f052391b9f2b9917b915b84a85bbbc"> 90</a></span> Lock_guard &<a class="code hl_function" href="classL4_1_1Lock__guard.html#a86f052391b9f2b9917b915b84a85bbbc">operator=</a>(Lock_guard &&guard)</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> {</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// Unlock the currently associated mutex (if any).</span></div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> reset();</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="comment">// Move the state from the other guard.</span></div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> _lock = guard._lock;</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> _status = guard._status;</div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// Release the mutex from the other guard.</span></div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> guard.release();</div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span></div>
|
|
<div class="foldopen" id="foldopen00110" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="classL4_1_1Lock__guard.html#ad763c179d4461e6e9ead650eab592fe6"> 110</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classL4_1_1Lock__guard.html#ad763c179d4461e6e9ead650eab592fe6">status</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="keyword"> </span>{</div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keywordflow">return</span> _status;</div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span></div>
|
|
<div class="foldopen" id="foldopen00126" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="classL4_1_1Lock__guard.html#a4ed9d5906e2f88e515d6bb7c03555752"> 126</a></span> <a class="code hl_function" href="classL4_1_1Lock__guard.html#a4ed9d5906e2f88e515d6bb7c03555752">~Lock_guard</a>()</div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> {</div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> reset();</div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">void</span> release()</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> {</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> _lock = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> }</div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span></div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <span class="keywordtype">void</span> reset()</div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> {</div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> <span class="comment">// No mutex might be associated with this lock guard only if the mutex has</span></div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="comment">// been moved to a different lock guard.</span></div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keywordflow">if</span> (_lock)</div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> {</div>
|
|
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> _status = pthread_mutex_unlock(_lock);</div>
|
|
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> release();</div>
|
|
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> }</div>
|
|
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> }</div>
|
|
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
|
|
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> pthread_mutex_t *_lock;</div>
|
|
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> <span class="keywordtype">int</span> _status;</div>
|
|
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> </div>
|
|
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span>} <span class="comment">// namespace L4</span></div>
|
|
<div class="ttc" id="aclassL4_1_1Lock__guard_html_a123c051b051fc44443dba6d5c6abf389"><div class="ttname"><a href="classL4_1_1Lock__guard.html#a123c051b051fc44443dba6d5c6abf389">L4::Lock_guard::Lock_guard</a></div><div class="ttdeci">Lock_guard(Lock_guard &&guard)</div><div class="ttdoc">Move constructor from other lock guard.</div><div class="ttdef"><b>Definition</b> <a href="#l00071">lock_guard.h:71</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Lock__guard_html_a39dc4304fc0e663c3992d7985f2527b8"><div class="ttname"><a href="classL4_1_1Lock__guard.html#a39dc4304fc0e663c3992d7985f2527b8">L4::Lock_guard::Lock_guard</a></div><div class="ttdeci">Lock_guard(pthread_mutex_t &lock)</div><div class="ttdoc">Construct the lock guard and lock the associated mutex.</div><div class="ttdef"><b>Definition</b> <a href="#l00059">lock_guard.h:59</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Lock__guard_html_a4ed9d5906e2f88e515d6bb7c03555752"><div class="ttname"><a href="classL4_1_1Lock__guard.html#a4ed9d5906e2f88e515d6bb7c03555752">L4::Lock_guard::~Lock_guard</a></div><div class="ttdeci">~Lock_guard()</div><div class="ttdoc">Lock guard destructor.</div><div class="ttdef"><b>Definition</b> <a href="#l00126">lock_guard.h:126</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Lock__guard_html_a86f052391b9f2b9917b915b84a85bbbc"><div class="ttname"><a href="classL4_1_1Lock__guard.html#a86f052391b9f2b9917b915b84a85bbbc">L4::Lock_guard::operator=</a></div><div class="ttdeci">Lock_guard & operator=(Lock_guard &&guard)</div><div class="ttdoc">Move assignment from other lock guard.</div><div class="ttdef"><b>Definition</b> <a href="#l00090">lock_guard.h:90</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Lock__guard_html_ad763c179d4461e6e9ead650eab592fe6"><div class="ttname"><a href="classL4_1_1Lock__guard.html#ad763c179d4461e6e9ead650eab592fe6">L4::Lock_guard::status</a></div><div class="ttdeci">int status() const</div><div class="ttdoc">Return last lock/unlock operation error status.</div><div class="ttdef"><b>Definition</b> <a href="#l00110">lock_guard.h:110</a></div></div>
|
|
<div class="ttc" id="anamespaceL4_html"><div class="ttname"><a href="namespaceL4.html">L4</a></div><div class="ttdoc">L4 low-level kernel interface.</div><div class="ttdef"><b>Definition</b> <a href="l4sys-l4f-groups_8dox_source.html#l00050">l4sys-l4f-groups.dox:50</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</div><!-- container -->
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>l4</b></li><li class="navelem"><b>cxx</b></li><li class="navelem"><a href="lock__guard_8h.html">lock_guard.h</a></li>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|