| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/mio/src/sys/unix/waker.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>waker.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../../normalize.css"><link rel="stylesheet" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../../ayu.css" disabled><link rel="stylesheet" href="../../../../dark.css" disabled><link rel="stylesheet" href="../../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../../storage.js"></script><script defer src="../../../../source-script.js"></script><script defer src="../../../../source-files.js"></script><script defer src="../../../../main.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../../mio/index.html"><div class="logo-container"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../mio/index.html"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| </pre><pre class="rust"><code><span class="attribute">#[cfg(any(target_os = <span class="string">"linux"</span>, target_os = <span class="string">"android"</span>))] |
| </span><span class="kw">mod </span>eventfd { |
| <span class="kw">use </span><span class="kw">crate</span>::sys::Selector; |
| <span class="kw">use crate</span>::{Interest, Token}; |
| <span class="attribute">#[cfg(target_vendor = <span class="string">"teaclave"</span>)] |
| </span><span class="kw">use </span>std::untrusted::fs::File; |
| <span class="attribute">#[cfg(not(target_vendor = <span class="string">"teaclave"</span>))] |
| </span><span class="kw">use </span>std::fs::File; |
| <span class="kw">use </span>std::io::{<span class="self">self</span>, Read, Write}; |
| <span class="kw">use </span>std::os::unix::io::FromRawFd; |
| |
| <span class="doccomment">/// Waker backed by `eventfd`. |
| /// |
| /// `eventfd` is effectively an 64 bit counter. All writes must be of 8 |
| /// bytes (64 bits) and are converted (native endian) into an 64 bit |
| /// unsigned integer and added to the count. Reads must also be 8 bytes and |
| /// reset the count to 0, returning the count. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Waker { |
| fd: File, |
| } |
| |
| <span class="kw">impl </span>Waker { |
| <span class="kw">pub fn </span>new(selector: <span class="kw-2">&</span>Selector, token: Token) -> io::Result<Waker> { |
| <span class="kw">let </span>fd = <span class="macro">syscall!</span>(eventfd(<span class="number">0</span>, libc::EFD_CLOEXEC | libc::EFD_NONBLOCK))<span class="question-mark">?</span>; |
| <span class="kw">let </span>file = <span class="kw">unsafe </span>{ File::from_raw_fd(fd) }; |
| |
| selector.register(fd, token, Interest::READABLE)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Waker { fd: file }) |
| } |
| |
| <span class="kw">pub fn </span>wake(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<()> { |
| <span class="kw">let </span>buf: [u8; <span class="number">8</span>] = <span class="number">1u64</span>.to_ne_bytes(); |
| <span class="kw">match </span>(<span class="kw-2">&</span><span class="self">self</span>.fd).write(<span class="kw-2">&</span>buf) { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="prelude-val">Ok</span>(()), |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>err) <span class="kw">if </span>err.kind() == io::ErrorKind::WouldBlock => { |
| <span class="comment">// Writing only blocks if the counter is going to overflow. |
| // So we'll reset the counter to 0 and wake it again. |
| </span><span class="self">self</span>.reset()<span class="question-mark">?</span>; |
| <span class="self">self</span>.wake() |
| } |
| <span class="prelude-val">Err</span>(err) => <span class="prelude-val">Err</span>(err), |
| } |
| } |
| |
| <span class="doccomment">/// Reset the eventfd object, only need to call this if `wake` fails. |
| </span><span class="kw">fn </span>reset(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<()> { |
| <span class="kw">let </span><span class="kw-2">mut </span>buf: [u8; <span class="number">8</span>] = <span class="number">0u64</span>.to_ne_bytes(); |
| <span class="kw">match </span>(<span class="kw-2">&</span><span class="self">self</span>.fd).read(<span class="kw-2">&mut </span>buf) { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="prelude-val">Ok</span>(()), |
| <span class="comment">// If the `Waker` hasn't been awoken yet this will return a |
| // `WouldBlock` error which we can safely ignore. |
| </span><span class="prelude-val">Err</span>(<span class="kw-2">ref </span>err) <span class="kw">if </span>err.kind() == io::ErrorKind::WouldBlock => <span class="prelude-val">Ok</span>(()), |
| <span class="prelude-val">Err</span>(err) => <span class="prelude-val">Err</span>(err), |
| } |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(any(target_os = <span class="string">"linux"</span>, target_os = <span class="string">"android"</span>))] |
| </span><span class="kw">pub use </span><span class="self">self</span>::eventfd::Waker; |
| |
| <span class="attribute">#[cfg(any( |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"ios"</span>, |
| target_os = <span class="string">"macos"</span>, |
| target_os = <span class="string">"tvos"</span>, |
| target_os = <span class="string">"watchos"</span>, |
| ))] |
| </span><span class="kw">mod </span>kqueue { |
| <span class="kw">use </span><span class="kw">crate</span>::sys::Selector; |
| <span class="kw">use </span><span class="kw">crate</span>::Token; |
| |
| <span class="kw">use </span>std::io; |
| |
| <span class="doccomment">/// Waker backed by kqueue user space notifications (`EVFILT_USER`). |
| /// |
| /// The implementation is fairly simple, first the kqueue must be setup to |
| /// receive waker events this done by calling `Selector.setup_waker`. Next |
| /// we need access to kqueue, thus we need to duplicate the file descriptor. |
| /// Now waking is as simple as adding an event to the kqueue. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Waker { |
| selector: Selector, |
| token: Token, |
| } |
| |
| <span class="kw">impl </span>Waker { |
| <span class="kw">pub fn </span>new(selector: <span class="kw-2">&</span>Selector, token: Token) -> io::Result<Waker> { |
| <span class="kw">let </span>selector = selector.try_clone()<span class="question-mark">?</span>; |
| selector.setup_waker(token)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Waker { selector, token }) |
| } |
| |
| <span class="kw">pub fn </span>wake(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.selector.wake(<span class="self">self</span>.token) |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(any( |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"ios"</span>, |
| target_os = <span class="string">"macos"</span>, |
| target_os = <span class="string">"tvos"</span>, |
| target_os = <span class="string">"watchos"</span>, |
| ))] |
| </span><span class="kw">pub use </span><span class="self">self</span>::kqueue::Waker; |
| |
| <span class="attribute">#[cfg(any( |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"illumos"</span>, |
| target_os = <span class="string">"netbsd"</span>, |
| target_os = <span class="string">"openbsd"</span>, |
| target_os = <span class="string">"redox"</span>, |
| ))] |
| </span><span class="kw">mod </span>pipe { |
| <span class="kw">use </span><span class="kw">crate</span>::sys::unix::Selector; |
| <span class="kw">use crate</span>::{Interest, Token}; |
| |
| <span class="kw">use </span>std::fs::File; |
| <span class="kw">use </span>std::io::{<span class="self">self</span>, Read, Write}; |
| <span class="kw">use </span>std::os::unix::io::FromRawFd; |
| |
| <span class="doccomment">/// Waker backed by a unix pipe. |
| /// |
| /// Waker controls both the sending and receiving ends and empties the pipe |
| /// if writing to it (waking) fails. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Waker { |
| sender: File, |
| receiver: File, |
| } |
| |
| <span class="kw">impl </span>Waker { |
| <span class="kw">pub fn </span>new(selector: <span class="kw-2">&</span>Selector, token: Token) -> io::Result<Waker> { |
| <span class="kw">let </span><span class="kw-2">mut </span>fds = [-<span class="number">1</span>; <span class="number">2</span>]; |
| <span class="macro">syscall!</span>(pipe2(fds.as_mut_ptr(), libc::O_NONBLOCK | libc::O_CLOEXEC))<span class="question-mark">?</span>; |
| <span class="kw">let </span>sender = <span class="kw">unsafe </span>{ File::from_raw_fd(fds[<span class="number">1</span>]) }; |
| <span class="kw">let </span>receiver = <span class="kw">unsafe </span>{ File::from_raw_fd(fds[<span class="number">0</span>]) }; |
| |
| selector.register(fds[<span class="number">0</span>], token, Interest::READABLE)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Waker { sender, receiver }) |
| } |
| |
| <span class="kw">pub fn </span>wake(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<()> { |
| <span class="comment">// The epoll emulation on some illumos systems currently requires |
| // the pipe buffer to be completely empty for an edge-triggered |
| // wakeup on the pipe read side. |
| </span><span class="attribute">#[cfg(target_os = <span class="string">"illumos"</span>)] |
| </span><span class="self">self</span>.empty(); |
| |
| <span class="kw">match </span>(<span class="kw-2">&</span><span class="self">self</span>.sender).write(<span class="kw-2">&</span>[<span class="number">1</span>]) { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="prelude-val">Ok</span>(()), |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>err) <span class="kw">if </span>err.kind() == io::ErrorKind::WouldBlock => { |
| <span class="comment">// The reading end is full so we'll empty the buffer and try |
| // again. |
| </span><span class="self">self</span>.empty(); |
| <span class="self">self</span>.wake() |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>err) <span class="kw">if </span>err.kind() == io::ErrorKind::Interrupted => <span class="self">self</span>.wake(), |
| <span class="prelude-val">Err</span>(err) => <span class="prelude-val">Err</span>(err), |
| } |
| } |
| |
| <span class="doccomment">/// Empty the pipe's buffer, only need to call this if `wake` fails. |
| /// This ignores any errors. |
| </span><span class="kw">fn </span>empty(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">4096</span>]; |
| <span class="kw">loop </span>{ |
| <span class="kw">match </span>(<span class="kw-2">&</span><span class="self">self</span>.receiver).read(<span class="kw-2">&mut </span>buf) { |
| <span class="prelude-val">Ok</span>(n) <span class="kw">if </span>n > <span class="number">0 </span>=> <span class="kw">continue</span>, |
| <span class="kw">_ </span>=> <span class="kw">return</span>, |
| } |
| } |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(any( |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"illumos"</span>, |
| target_os = <span class="string">"netbsd"</span>, |
| target_os = <span class="string">"openbsd"</span>, |
| target_os = <span class="string">"redox"</span>, |
| ))] |
| </span><span class="kw">pub use </span><span class="self">self</span>::pipe::Waker; |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="mio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |