Google Git
Sign in
fuchsia / third_party / mio / upstream/gh-pages / . / doc / src / mio / sys / unix / uds / listener.rs.html
blob: 5deef9cec7e3dde9878aabf24234ed481c8d6d1b [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 `src/sys/unix/uds/listener.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>listener.rs - source</title><link rel="stylesheet" type="text/css" href="../../../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../../../storage.js"></script><script src="../../../../../crates.js"></script><noscript><link rel="stylesheet" href="../../../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../../../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../../../../mio/index.html'><div class='logo-container rust-logo'><img src='../../../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../../../../settings.html"><img src="../../../../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">socket_addr</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">net</span>::{<span class="ident">SocketAddr</span>, <span class="ident">UnixStream</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">sys</span>::<span class="ident">unix</span>::<span class="ident">net</span>::<span class="ident">new_socket</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">io</span>::{<span class="ident">AsRawFd</span>, <span class="ident">FromRawFd</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">net</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">Path</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">io</span>, <span class="ident">mem</span>};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">bind</span>(<span class="ident">path</span>: <span class="kw-2">&amp;</span><span class="ident">Path</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">net</span>::<span class="ident">UnixListener</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">new_socket</span>(<span class="ident">libc</span>::<span class="ident">AF_UNIX</span>, <span class="ident">libc</span>::<span class="ident">SOCK_STREAM</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> (<span class="ident">sockaddr</span>, <span class="ident">socklen</span>) <span class="op">=</span> <span class="ident">socket_addr</span>(<span class="ident">path</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">sockaddr</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="ident">sockaddr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">libc</span>::<span class="ident">sockaddr_un</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">libc</span>::<span class="ident">sockaddr</span>;
<span class="macro">syscall</span><span class="macro">!</span>(<span class="ident">bind</span>(<span class="ident">socket</span>, <span class="ident">sockaddr</span>, <span class="ident">socklen</span>))
.<span class="ident">and_then</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="macro">syscall</span><span class="macro">!</span>(<span class="ident">listen</span>(<span class="ident">socket</span>, <span class="number">1024</span>)))
.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> {
<span class="comment">// Close the socket if we hit an error, ignoring the error from</span>
<span class="comment">// closing since we can&#39;t pass back two errors.</span>
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">libc</span>::<span class="ident">close</span>(<span class="ident">socket</span>) };
<span class="ident">err</span>
})
.<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">net</span>::<span class="ident">UnixListener</span>::<span class="ident">from_raw_fd</span>(<span class="ident">socket</span>) })
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">accept</span>(<span class="ident">listener</span>: <span class="kw-2">&amp;</span><span class="ident">net</span>::<span class="ident">UnixListener</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>(<span class="ident">UnixStream</span>, <span class="ident">SocketAddr</span>)<span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">sockaddr</span> <span class="op">=</span> <span class="ident">mem</span>::<span class="ident">MaybeUninit</span>::<span class="op">&lt;</span><span class="ident">libc</span>::<span class="ident">sockaddr_un</span><span class="op">&gt;</span>::<span class="ident">zeroed</span>();
<span class="comment">// This is safe to assume because a `libc::sockaddr_un` filled with `0`</span>
<span class="comment">// bytes is properly initialized.</span>
<span class="comment">//</span>
<span class="comment">// `0` is a valid value for `sockaddr_un::sun_family`; it is</span>
<span class="comment">// `libc::AF_UNSPEC`.</span>
<span class="comment">//</span>
<span class="comment">// `[0; 108]` is a valid value for `sockaddr_un::sun_path`; it begins an</span>
<span class="comment">// abstract path.</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sockaddr</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">sockaddr</span>.<span class="ident">assume_init</span>() };
<span class="ident">sockaddr</span>.<span class="ident">sun_family</span> <span class="op">=</span> <span class="ident">libc</span>::<span class="ident">AF_UNIX</span> <span class="kw">as</span> <span class="ident">libc</span>::<span class="ident">sa_family_t</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">socklen</span> <span class="op">=</span> <span class="ident">mem</span>::<span class="ident">size_of_val</span>(<span class="kw-2">&amp;</span><span class="ident">sockaddr</span>) <span class="kw">as</span> <span class="ident">libc</span>::<span class="ident">socklen_t</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">any</span>(
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;ios&quot;</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;macos&quot;</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;netbsd&quot;</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;solaris&quot;</span>,
<span class="comment">// Android x86&#39;s seccomp profile forbids calls to `accept4(2)`</span>
<span class="comment">// See https://github.com/tokio-rs/mio/issues/1445 for details</span>
<span class="ident">all</span>(
<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">&quot;x86&quot;</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;android&quot;</span>
)
)))]</span>
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> {
<span class="kw">let</span> <span class="ident">flags</span> <span class="op">=</span> <span class="ident">libc</span>::<span class="ident">SOCK_NONBLOCK</span> <span class="op">|</span> <span class="ident">libc</span>::<span class="ident">SOCK_CLOEXEC</span>;
<span class="macro">syscall</span><span class="macro">!</span>(<span class="ident">accept4</span>(
<span class="ident">listener</span>.<span class="ident">as_raw_fd</span>(),
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">sockaddr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">sockaddr_un</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">sockaddr</span>,
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">socklen</span>,
<span class="ident">flags</span>
))
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">socket</span><span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">net</span>::<span class="ident">UnixStream</span>::<span class="ident">from_raw_fd</span>(<span class="ident">socket</span>) })
};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;ios&quot;</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;macos&quot;</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;netbsd&quot;</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;solaris&quot;</span>,
<span class="ident">all</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">&quot;x86&quot;</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;android&quot;</span>)
))]</span>
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="macro">syscall</span><span class="macro">!</span>(<span class="ident">accept</span>(
<span class="ident">listener</span>.<span class="ident">as_raw_fd</span>(),
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">sockaddr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">sockaddr_un</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">sockaddr</span>,
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">socklen</span>,
))
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">socket</span><span class="op">|</span> {
<span class="comment">// Ensure the socket is closed if either of the `fcntl` calls</span>
<span class="comment">// error below.</span>
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">net</span>::<span class="ident">UnixStream</span>::<span class="ident">from_raw_fd</span>(<span class="ident">socket</span>) };
<span class="macro">syscall</span><span class="macro">!</span>(<span class="ident">fcntl</span>(<span class="ident">socket</span>, <span class="ident">libc</span>::<span class="ident">F_SETFD</span>, <span class="ident">libc</span>::<span class="ident">FD_CLOEXEC</span>))<span class="question-mark">?</span>;
<span class="comment">// See https://github.com/tokio-rs/mio/issues/1450</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">&quot;x86&quot;</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;android&quot;</span>))]</span>
<span class="macro">syscall</span><span class="macro">!</span>(<span class="ident">fcntl</span>(<span class="ident">socket</span>, <span class="ident">libc</span>::<span class="ident">F_SETFL</span>, <span class="ident">libc</span>::<span class="ident">O_NONBLOCK</span>))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">s</span>)
});
<span class="ident">socket</span>
.<span class="ident">map</span>(<span class="ident">UnixStream</span>::<span class="ident">from_std</span>)
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">stream</span><span class="op">|</span> (<span class="ident">stream</span>, <span class="ident">SocketAddr</span>::<span class="ident">from_parts</span>(<span class="ident">sockaddr</span>, <span class="ident">socklen</span>)))
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">local_addr</span>(<span class="ident">listener</span>: <span class="kw-2">&amp;</span><span class="ident">net</span>::<span class="ident">UnixListener</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">SocketAddr</span><span class="op">&gt;</span> {
<span class="kw">super</span>::<span class="ident">local_addr</span>(<span class="ident">listener</span>.<span class="ident">as_raw_fd</span>())
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="mio" data-search-js="../../../../../search-index.js"></div>
<script src="../../../../../main.js"></script><script src="../../../../../source-script.js"></script><script src="../../../../../source-files.js"></script></body></html>