| <!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/uds/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="../../../../../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> |
| </pre><pre class="rust"><code><span class="kw">mod </span>socketaddr; |
| <span class="kw">pub use </span><span class="self">self</span>::socketaddr::SocketAddr; |
| |
| <span class="doccomment">/// Get the `sun_path` field offset of `sockaddr_un` for the target OS. |
| /// |
| /// On Linux, this function equates to the same value as |
| /// `size_of::<sa_family_t>()`, but some other implementations include |
| /// other fields before `sun_path`, so the expression more portably |
| /// describes the size of the address structure. |
| </span><span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::sys) <span class="kw">fn </span>path_offset(sockaddr: <span class="kw-2">&</span>libc::sockaddr_un) -> usize { |
| <span class="kw">let </span>base = sockaddr <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>usize; |
| <span class="kw">let </span>path = <span class="kw-2">&</span>sockaddr.sun_path <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>usize; |
| path - base |
| } |
| |
| <span class="macro">cfg_os_poll! </span>{ |
| <span class="kw">use </span>std::cmp::Ordering; |
| <span class="kw">use </span>std::os::unix::ffi::OsStrExt; |
| <span class="kw">use </span>std::os::unix::io::{RawFd, FromRawFd}; |
| <span class="kw">use </span>std::path::Path; |
| <span class="kw">use </span>std::{io, mem}; |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>datagram; |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>listener; |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>stream; |
| |
| <span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::sys) <span class="kw">fn </span>socket_addr(path: <span class="kw-2">&</span>Path) -> io::Result<(libc::sockaddr_un, libc::socklen_t)> { |
| <span class="kw">let </span>sockaddr = mem::MaybeUninit::<libc::sockaddr_un>::zeroed(); |
| |
| <span class="comment">// This is safe to assume because a `libc::sockaddr_un` filled with `0` |
| // bytes is properly initialized. |
| // |
| // `0` is a valid value for `sockaddr_un::sun_family`; it is |
| // `libc::AF_UNSPEC`. |
| // |
| // `[0; 108]` is a valid value for `sockaddr_un::sun_path`; it begins an |
| // abstract path. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>sockaddr = <span class="kw">unsafe </span>{ sockaddr.assume_init() }; |
| |
| sockaddr.sun_family = libc::AF_UNIX <span class="kw">as </span>libc::sa_family_t; |
| |
| <span class="kw">let </span>bytes = path.as_os_str().as_bytes(); |
| <span class="kw">match </span>(bytes.first(), bytes.len().cmp(<span class="kw-2">&</span>sockaddr.sun_path.len())) { |
| <span class="comment">// Abstract paths don't need a null terminator |
| </span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">0</span>), Ordering::Greater) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::new( |
| io::ErrorKind::InvalidInput, |
| <span class="string">"path must be no longer than libc::sockaddr_un.sun_path"</span>, |
| )); |
| } |
| (<span class="kw">_</span>, Ordering::Greater) | (<span class="kw">_</span>, Ordering::Equal) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::new( |
| io::ErrorKind::InvalidInput, |
| <span class="string">"path must be shorter than libc::sockaddr_un.sun_path"</span>, |
| )); |
| } |
| <span class="kw">_ </span>=> {} |
| } |
| |
| <span class="kw">for </span>(dst, src) <span class="kw">in </span>sockaddr.sun_path.iter_mut().zip(bytes.iter()) { |
| <span class="kw-2">*</span>dst = <span class="kw-2">*</span>src <span class="kw">as </span>libc::c_char; |
| } |
| |
| <span class="kw">let </span>offset = path_offset(<span class="kw-2">&</span>sockaddr); |
| <span class="kw">let </span><span class="kw-2">mut </span>socklen = offset + bytes.len(); |
| |
| <span class="kw">match </span>bytes.first() { |
| <span class="comment">// The struct has already been zeroes so the null byte for pathname |
| // addresses is already there. |
| </span><span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">0</span>) | <span class="prelude-val">None </span>=> {} |
| <span class="prelude-val">Some</span>(<span class="kw">_</span>) => socklen += <span class="number">1</span>, |
| } |
| |
| <span class="prelude-val">Ok</span>((sockaddr, socklen <span class="kw">as </span>libc::socklen_t)) |
| } |
| |
| <span class="kw">fn </span>pair<T>(flags: libc::c_int) -> io::Result<(T, T)> |
| <span class="kw">where </span>T: FromRawFd, |
| { |
| <span class="attribute">#[cfg(not(any( |
| 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">let </span>flags = flags | libc::SOCK_NONBLOCK | libc::SOCK_CLOEXEC; |
| |
| <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>(socketpair(libc::AF_UNIX, flags, <span class="number">0</span>, fds.as_mut_ptr()))<span class="question-mark">?</span>; |
| <span class="kw">let </span>pair = <span class="kw">unsafe </span>{ (T::from_raw_fd(fds[<span class="number">0</span>]), T::from_raw_fd(fds[<span class="number">1</span>])) }; |
| |
| <span class="comment">// Darwin doesn't have SOCK_NONBLOCK or SOCK_CLOEXEC. |
| // |
| // In order to set those flags, additional `fcntl` sys calls must be |
| // performed. If a `fnctl` fails after the sockets have been created, |
| // the file descriptors will leak. Creating `pair` above ensures that if |
| // there is an error, the file descriptors are closed. |
| </span><span class="attribute">#[cfg(any( |
| 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="macro">syscall!</span>(fcntl(fds[<span class="number">0</span>], libc::F_SETFL, libc::O_NONBLOCK))<span class="question-mark">?</span>; |
| <span class="macro">syscall!</span>(fcntl(fds[<span class="number">0</span>], libc::F_SETFD, libc::FD_CLOEXEC))<span class="question-mark">?</span>; |
| <span class="macro">syscall!</span>(fcntl(fds[<span class="number">1</span>], libc::F_SETFL, libc::O_NONBLOCK))<span class="question-mark">?</span>; |
| <span class="macro">syscall!</span>(fcntl(fds[<span class="number">1</span>], libc::F_SETFD, libc::FD_CLOEXEC))<span class="question-mark">?</span>; |
| } |
| <span class="prelude-val">Ok</span>(pair) |
| } |
| |
| <span class="comment">// The following functions can't simply be replaced with a call to |
| // `net::UnixDatagram` because of our `SocketAddr` type. |
| |
| </span><span class="kw">fn </span>local_addr(socket: RawFd) -> io::Result<SocketAddr> { |
| SocketAddr::new(|sockaddr, socklen| <span class="macro">syscall!</span>(getsockname(socket, sockaddr, socklen))) |
| } |
| |
| <span class="kw">fn </span>peer_addr(socket: RawFd) -> io::Result<SocketAddr> { |
| SocketAddr::new(|sockaddr, socklen| <span class="macro">syscall!</span>(getpeername(socket, sockaddr, socklen))) |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::{path_offset, socket_addr}; |
| <span class="kw">use </span>std::path::Path; |
| <span class="kw">use </span>std::str; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>pathname_address() { |
| <span class="kw">const </span>PATH: <span class="kw-2">&</span>str = <span class="string">"./foo/bar.txt"</span>; |
| <span class="kw">const </span>PATH_LEN: usize = <span class="number">13</span>; |
| |
| <span class="comment">// Pathname addresses do have a null terminator, so `socklen` is |
| // expected to be `PATH_LEN` + `offset` + 1. |
| </span><span class="kw">let </span>path = Path::new(PATH); |
| <span class="kw">let </span>(sockaddr, actual) = socket_addr(path).unwrap(); |
| <span class="kw">let </span>offset = path_offset(<span class="kw-2">&</span>sockaddr); |
| <span class="kw">let </span>expected = PATH_LEN + offset + <span class="number">1</span>; |
| <span class="macro">assert_eq!</span>(expected <span class="kw">as </span>libc::socklen_t, actual) |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>abstract_address() { |
| <span class="kw">const </span>PATH: <span class="kw-2">&</span>[u8] = <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">116</span>, <span class="number">111</span>, <span class="number">107</span>, <span class="number">105</span>, <span class="number">111</span>]; |
| <span class="kw">const </span>PATH_LEN: usize = <span class="number">6</span>; |
| |
| <span class="comment">// Abstract addresses do not have a null terminator, so `socklen` is |
| // expected to be `PATH_LEN` + `offset`. |
| </span><span class="kw">let </span>abstract_path = str::from_utf8(PATH).unwrap(); |
| <span class="kw">let </span>path = Path::new(abstract_path); |
| <span class="kw">let </span>(sockaddr, actual) = socket_addr(path).unwrap(); |
| <span class="kw">let </span>offset = path_offset(<span class="kw-2">&</span>sockaddr); |
| <span class="kw">let </span>expected = PATH_LEN + offset; |
| <span class="macro">assert_eq!</span>(expected <span class="kw">as </span>libc::socklen_t, actual) |
| } |
| } |
| } |
| </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> |
