Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / ctrlc / platform / unix / mod.rs.html
blob: a882563ce6f57d8a08f7fb2be6868dd81bec574d [file] [log] [blame]
<!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/registry/src/github.com-1ecc6299db9ec823/ctrlc-3.4.0/src/platform/unix/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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="../../../../ctrlc/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="../../../../ctrlc/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>
</pre><pre class="rust"><code><span class="comment">// Copyright (c) 2017 CtrlC developers
// Licensed under the Apache License, Version 2.0
// &lt;LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT
// license &lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;,
// at your option. All files in the project carrying such
// notice may not be copied, modified, or distributed except
// according to those terms.
</span><span class="kw">use </span><span class="kw">crate</span>::error::Error <span class="kw">as </span>CtrlcError;
<span class="kw">use </span>nix::unistd;
<span class="kw">use </span>std::os::unix::io::RawFd;
<span class="kw">static </span><span class="kw-2">mut </span>PIPE: (RawFd, RawFd) = (-<span class="number">1</span>, -<span class="number">1</span>);
<span class="doccomment">/// Platform specific error type
</span><span class="kw">pub type </span>Error = nix::Error;
<span class="doccomment">/// Platform specific signal type
</span><span class="kw">pub type </span>Signal = nix::sys::signal::Signal;
<span class="kw">extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>os_handler(<span class="kw">_</span>: nix::libc::c_int) {
<span class="comment">// Assuming this always succeeds. Can&#39;t really handle errors in any meaningful way.
</span><span class="kw">unsafe </span>{
<span class="kw">let _ </span>= unistd::write(PIPE.<span class="number">1</span>, <span class="kw-2">&amp;</span>[<span class="number">0u8</span>]);
}
}
<span class="comment">// pipe2(2) is not available on macOS, iOS, AIX or Haiku, so we need to use pipe(2) and fcntl(2)
</span><span class="attribute">#[inline]
#[cfg(any(
target_os = <span class="string">&quot;ios&quot;</span>,
target_os = <span class="string">&quot;macos&quot;</span>,
target_os = <span class="string">&quot;haiku&quot;</span>,
target_os = <span class="string">&quot;aix&quot;
</span>))]
</span><span class="kw">fn </span>pipe2(flags: nix::fcntl::OFlag) -&gt; nix::Result&lt;(RawFd, RawFd)&gt; {
<span class="kw">use </span>nix::fcntl::{fcntl, FcntlArg, FdFlag, OFlag};
<span class="kw">let </span>pipe = unistd::pipe()<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>res = <span class="prelude-val">Ok</span>(<span class="number">0</span>);
<span class="kw">if </span>flags.contains(OFlag::O_CLOEXEC) {
res = res
.and_then(|<span class="kw">_</span>| fcntl(pipe.<span class="number">0</span>, FcntlArg::F_SETFD(FdFlag::FD_CLOEXEC)))
.and_then(|<span class="kw">_</span>| fcntl(pipe.<span class="number">1</span>, FcntlArg::F_SETFD(FdFlag::FD_CLOEXEC)));
}
<span class="kw">if </span>flags.contains(OFlag::O_NONBLOCK) {
res = res
.and_then(|<span class="kw">_</span>| fcntl(pipe.<span class="number">0</span>, FcntlArg::F_SETFL(OFlag::O_NONBLOCK)))
.and_then(|<span class="kw">_</span>| fcntl(pipe.<span class="number">1</span>, FcntlArg::F_SETFL(OFlag::O_NONBLOCK)));
}
<span class="kw">match </span>res {
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="prelude-val">Ok</span>(pipe),
<span class="prelude-val">Err</span>(e) =&gt; {
<span class="kw">let _ </span>= unistd::close(pipe.<span class="number">0</span>);
<span class="kw">let _ </span>= unistd::close(pipe.<span class="number">1</span>);
<span class="prelude-val">Err</span>(e)
}
}
}
<span class="attribute">#[inline]
#[cfg(not(any(
target_os = <span class="string">&quot;ios&quot;</span>,
target_os = <span class="string">&quot;macos&quot;</span>,
target_os = <span class="string">&quot;haiku&quot;</span>,
target_os = <span class="string">&quot;aix&quot;
</span>)))]
</span><span class="kw">fn </span>pipe2(flags: nix::fcntl::OFlag) -&gt; nix::Result&lt;(RawFd, RawFd)&gt; {
unistd::pipe2(flags)
}
<span class="doccomment">/// Register os signal handler.
///
/// Must be called before calling [`block_ctrl_c()`](fn.block_ctrl_c.html)
/// and should only be called once.
///
/// # Errors
/// Will return an error if a system error occurred.
///
</span><span class="attribute">#[inline]
</span><span class="kw">pub unsafe fn </span>init_os_handler(overwrite: bool) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="kw">use </span>nix::fcntl;
<span class="kw">use </span>nix::sys::signal;
PIPE = pipe2(fcntl::OFlag::O_CLOEXEC)<span class="question-mark">?</span>;
<span class="kw">let </span>close_pipe = |e: nix::Error| -&gt; Error {
<span class="comment">// Try to close the pipes. close() should not fail,
// but if it does, there isn&#39;t much we can do
</span><span class="kw">let _ </span>= unistd::close(PIPE.<span class="number">1</span>);
<span class="kw">let _ </span>= unistd::close(PIPE.<span class="number">0</span>);
e
};
<span class="comment">// Make sure we never block on write in the os handler.
</span><span class="kw">if let </span><span class="prelude-val">Err</span>(e) = fcntl::fcntl(PIPE.<span class="number">1</span>, fcntl::FcntlArg::F_SETFL(fcntl::OFlag::O_NONBLOCK)) {
<span class="kw">return </span><span class="prelude-val">Err</span>(close_pipe(e));
}
<span class="kw">let </span>handler = signal::SigHandler::Handler(os_handler);
<span class="kw">let </span>new_action = signal::SigAction::new(
handler,
signal::SaFlags::SA_RESTART,
signal::SigSet::empty(),
);
<span class="kw">let </span>sigint_old = <span class="kw">match </span>signal::sigaction(signal::Signal::SIGINT, <span class="kw-2">&amp;</span>new_action) {
<span class="prelude-val">Ok</span>(old) =&gt; old,
<span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(close_pipe(e)),
};
<span class="kw">if </span>!overwrite &amp;&amp; sigint_old.handler() != signal::SigHandler::SigDfl {
signal::sigaction(signal::Signal::SIGINT, <span class="kw-2">&amp;</span>sigint_old).unwrap();
<span class="kw">return </span><span class="prelude-val">Err</span>(close_pipe(nix::Error::EEXIST));
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;termination&quot;</span>)]
</span>{
<span class="kw">let </span>sigterm_old = <span class="kw">match </span>signal::sigaction(signal::Signal::SIGTERM, <span class="kw-2">&amp;</span>new_action) {
<span class="prelude-val">Ok</span>(old) =&gt; old,
<span class="prelude-val">Err</span>(e) =&gt; {
signal::sigaction(signal::Signal::SIGINT, <span class="kw-2">&amp;</span>sigint_old).unwrap();
<span class="kw">return </span><span class="prelude-val">Err</span>(close_pipe(e));
}
};
<span class="kw">if </span>!overwrite &amp;&amp; sigterm_old.handler() != signal::SigHandler::SigDfl {
signal::sigaction(signal::Signal::SIGINT, <span class="kw-2">&amp;</span>sigint_old).unwrap();
signal::sigaction(signal::Signal::SIGTERM, <span class="kw-2">&amp;</span>sigterm_old).unwrap();
<span class="kw">return </span><span class="prelude-val">Err</span>(close_pipe(nix::Error::EEXIST));
}
<span class="kw">let </span>sighup_old = <span class="kw">match </span>signal::sigaction(signal::Signal::SIGHUP, <span class="kw-2">&amp;</span>new_action) {
<span class="prelude-val">Ok</span>(old) =&gt; old,
<span class="prelude-val">Err</span>(e) =&gt; {
signal::sigaction(signal::Signal::SIGINT, <span class="kw-2">&amp;</span>sigint_old).unwrap();
signal::sigaction(signal::Signal::SIGTERM, <span class="kw-2">&amp;</span>sigterm_old).unwrap();
<span class="kw">return </span><span class="prelude-val">Err</span>(close_pipe(e));
}
};
<span class="kw">if </span>!overwrite &amp;&amp; sighup_old.handler() != signal::SigHandler::SigDfl {
signal::sigaction(signal::Signal::SIGINT, <span class="kw-2">&amp;</span>sigint_old).unwrap();
signal::sigaction(signal::Signal::SIGTERM, <span class="kw-2">&amp;</span>sigterm_old).unwrap();
signal::sigaction(signal::Signal::SIGHUP, <span class="kw-2">&amp;</span>sighup_old).unwrap();
<span class="kw">return </span><span class="prelude-val">Err</span>(close_pipe(nix::Error::EEXIST));
}
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Blocks until a Ctrl-C signal is received.
///
/// Must be called after calling [`init_os_handler()`](fn.init_os_handler.html).
///
/// # Errors
/// Will return an error if a system error occurred.
///
</span><span class="attribute">#[inline]
</span><span class="kw">pub unsafe fn </span>block_ctrl_c() -&gt; <span class="prelude-ty">Result</span>&lt;(), CtrlcError&gt; {
<span class="kw">use </span>std::io;
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0u8</span>];
<span class="comment">// TODO: Can we safely convert the pipe fd into a std::io::Read
// with std::os::unix::io::FromRawFd, this would handle EINTR
// and everything for us.
</span><span class="kw">loop </span>{
<span class="kw">match </span>unistd::read(PIPE.<span class="number">0</span>, <span class="kw-2">&amp;mut </span>buf[..]) {
<span class="prelude-val">Ok</span>(<span class="number">1</span>) =&gt; <span class="kw">break</span>,
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(CtrlcError::System(io::ErrorKind::UnexpectedEof.into())),
<span class="prelude-val">Err</span>(nix::errno::Errno::EINTR) =&gt; {}
<span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(e.into()),
}
}
<span class="prelude-val">Ok</span>(())
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="ctrlc" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>