blob: 3f48b800d1e52a6466f0c3ec4457d25d46a0f5ee [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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/mio/src/sys/unix/net.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>net.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::io;
<span class="kw">use </span>std::mem::size_of;
<span class="kw">use </span>std::net::{Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_ip_socket(addr: SocketAddr, socket_type: libc::c_int) -&gt; io::Result&lt;libc::c_int&gt; {
<span class="kw">let </span>domain = <span class="kw">match </span>addr {
SocketAddr::V4(..) =&gt; libc::AF_INET,
SocketAddr::V6(..) =&gt; libc::AF_INET6,
};
new_socket(domain, socket_type)
}
<span class="doccomment">/// Create a new non-blocking socket.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_socket(domain: libc::c_int, socket_type: libc::c_int) -&gt; io::Result&lt;libc::c_int&gt; {
<span class="attribute">#[cfg(any(
target_os = <span class="string">&quot;android&quot;</span>,
target_os = <span class="string">&quot;dragonfly&quot;</span>,
target_os = <span class="string">&quot;freebsd&quot;</span>,
target_os = <span class="string">&quot;illumos&quot;</span>,
target_os = <span class="string">&quot;linux&quot;</span>,
target_os = <span class="string">&quot;netbsd&quot;</span>,
target_os = <span class="string">&quot;openbsd&quot;</span>,
))]
</span><span class="kw">let </span>socket_type = socket_type | libc::SOCK_NONBLOCK | libc::SOCK_CLOEXEC;
<span class="kw">let </span>socket = <span class="macro">syscall!</span>(socket(domain, socket_type, <span class="number">0</span>))<span class="question-mark">?</span>;
<span class="comment">// Mimick `libstd` and set `SO_NOSIGPIPE` on apple systems.
</span><span class="attribute">#[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;tvos&quot;</span>,
target_os = <span class="string">&quot;watchos&quot;</span>,
))]
</span><span class="kw">if let </span><span class="prelude-val">Err</span>(err) = <span class="macro">syscall!</span>(setsockopt(
socket,
libc::SOL_SOCKET,
libc::SO_NOSIGPIPE,
<span class="kw-2">&amp;</span><span class="number">1 </span><span class="kw">as </span><span class="kw-2">*const </span>libc::c_int <span class="kw">as </span><span class="kw-2">*const </span>libc::c_void,
size_of::&lt;libc::c_int&gt;() <span class="kw">as </span>libc::socklen_t
)) {
<span class="kw">let _ </span>= <span class="macro">syscall!</span>(close(socket));
<span class="kw">return </span><span class="prelude-val">Err</span>(err);
}
<span class="comment">// Darwin doesn&#39;t have SOCK_NONBLOCK or SOCK_CLOEXEC.
</span><span class="attribute">#[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;tvos&quot;</span>,
target_os = <span class="string">&quot;watchos&quot;</span>,
))]
</span>{
<span class="kw">if let </span><span class="prelude-val">Err</span>(err) = <span class="macro">syscall!</span>(fcntl(socket, libc::F_SETFL, libc::O_NONBLOCK)) {
<span class="kw">let _ </span>= <span class="macro">syscall!</span>(close(socket));
<span class="kw">return </span><span class="prelude-val">Err</span>(err);
}
<span class="kw">if let </span><span class="prelude-val">Err</span>(err) = <span class="macro">syscall!</span>(fcntl(socket, libc::F_SETFD, libc::FD_CLOEXEC)) {
<span class="kw">let _ </span>= <span class="macro">syscall!</span>(close(socket));
<span class="kw">return </span><span class="prelude-val">Err</span>(err);
}
}
<span class="prelude-val">Ok</span>(socket)
}
<span class="doccomment">/// A type with the same memory layout as `libc::sockaddr`. Used in converting Rust level
/// SocketAddr* types into their system representation. The benefit of this specific
/// type over using `libc::sockaddr_storage` is that this type is exactly as large as it
/// needs to be and not a lot larger. And it can be initialized cleaner from Rust.
</span><span class="attribute">#[repr(C)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">union </span>SocketAddrCRepr {
v4: libc::sockaddr_in,
v6: libc::sockaddr_in6,
}
<span class="kw">impl </span>SocketAddrCRepr {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>as_ptr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">*const </span>libc::sockaddr {
<span class="self">self </span><span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span><span class="kw-2">*const </span>libc::sockaddr
}
}
<span class="doccomment">/// Converts a Rust `SocketAddr` into the system representation.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>socket_addr(addr: <span class="kw-2">&amp;</span>SocketAddr) -&gt; (SocketAddrCRepr, libc::socklen_t) {
<span class="kw">match </span>addr {
SocketAddr::V4(<span class="kw-2">ref </span>addr) =&gt; {
<span class="comment">// `s_addr` is stored as BE on all machine and the array is in BE order.
// So the native endian conversion method is used so that it&#39;s never swapped.
</span><span class="kw">let </span>sin_addr = libc::in_addr {
s_addr: u32::from_ne_bytes(addr.ip().octets()),
};
<span class="kw">let </span>sockaddr_in = libc::sockaddr_in {
sin_family: libc::AF_INET <span class="kw">as </span>libc::sa_family_t,
sin_port: addr.port().to_be(),
sin_addr,
sin_zero: [<span class="number">0</span>; <span class="number">8</span>],
<span class="attribute">#[cfg(any(
target_os = <span class="string">&quot;dragonfly&quot;</span>,
target_os = <span class="string">&quot;freebsd&quot;</span>,
target_os = <span class="string">&quot;ios&quot;</span>,
target_os = <span class="string">&quot;macos&quot;</span>,
target_os = <span class="string">&quot;netbsd&quot;</span>,
target_os = <span class="string">&quot;openbsd&quot;</span>,
target_os = <span class="string">&quot;tvos&quot;</span>,
target_os = <span class="string">&quot;watchos&quot;</span>,
))]
</span>sin_len: <span class="number">0</span>,
};
<span class="kw">let </span>sockaddr = SocketAddrCRepr { v4: sockaddr_in };
<span class="kw">let </span>socklen = size_of::&lt;libc::sockaddr_in&gt;() <span class="kw">as </span>libc::socklen_t;
(sockaddr, socklen)
}
SocketAddr::V6(<span class="kw-2">ref </span>addr) =&gt; {
<span class="kw">let </span>sockaddr_in6 = libc::sockaddr_in6 {
sin6_family: libc::AF_INET6 <span class="kw">as </span>libc::sa_family_t,
sin6_port: addr.port().to_be(),
sin6_addr: libc::in6_addr {
s6_addr: addr.ip().octets(),
},
sin6_flowinfo: addr.flowinfo(),
sin6_scope_id: addr.scope_id(),
<span class="attribute">#[cfg(any(
target_os = <span class="string">&quot;dragonfly&quot;</span>,
target_os = <span class="string">&quot;freebsd&quot;</span>,
target_os = <span class="string">&quot;ios&quot;</span>,
target_os = <span class="string">&quot;macos&quot;</span>,
target_os = <span class="string">&quot;netbsd&quot;</span>,
target_os = <span class="string">&quot;openbsd&quot;</span>,
target_os = <span class="string">&quot;tvos&quot;</span>,
target_os = <span class="string">&quot;watchos&quot;</span>,
))]
</span>sin6_len: <span class="number">0</span>,
<span class="attribute">#[cfg(target_os = <span class="string">&quot;illumos&quot;</span>)]
</span>__sin6_src_id: <span class="number">0</span>,
};
<span class="kw">let </span>sockaddr = SocketAddrCRepr { v6: sockaddr_in6 };
<span class="kw">let </span>socklen = size_of::&lt;libc::sockaddr_in6&gt;() <span class="kw">as </span>libc::socklen_t;
(sockaddr, socklen)
}
}
}
<span class="doccomment">/// Converts a `libc::sockaddr` compatible struct into a native Rust `SocketAddr`.
///
/// # Safety
///
/// `storage` must have the `ss_family` field correctly initialized.
/// `storage` must be initialised to a `sockaddr_in` or `sockaddr_in6`.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">unsafe fn </span>to_socket_addr(
storage: <span class="kw-2">*const </span>libc::sockaddr_storage,
) -&gt; io::Result&lt;SocketAddr&gt; {
<span class="kw">match </span>(<span class="kw-2">*</span>storage).ss_family <span class="kw">as </span>libc::c_int {
libc::AF_INET =&gt; {
<span class="comment">// Safety: if the ss_family field is AF_INET then storage must be a sockaddr_in.
</span><span class="kw">let </span>addr: <span class="kw-2">&amp;</span>libc::sockaddr_in = <span class="kw-2">&amp;*</span>(storage <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr_in);
<span class="kw">let </span>ip = Ipv4Addr::from(addr.sin_addr.s_addr.to_ne_bytes());
<span class="kw">let </span>port = u16::from_be(addr.sin_port);
<span class="prelude-val">Ok</span>(SocketAddr::V4(SocketAddrV4::new(ip, port)))
}
libc::AF_INET6 =&gt; {
<span class="comment">// Safety: if the ss_family field is AF_INET6 then storage must be a sockaddr_in6.
</span><span class="kw">let </span>addr: <span class="kw-2">&amp;</span>libc::sockaddr_in6 = <span class="kw-2">&amp;*</span>(storage <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr_in6);
<span class="kw">let </span>ip = Ipv6Addr::from(addr.sin6_addr.s6_addr);
<span class="kw">let </span>port = u16::from_be(addr.sin6_port);
<span class="prelude-val">Ok</span>(SocketAddr::V6(SocketAddrV6::new(
ip,
port,
addr.sin6_flowinfo,
addr.sin6_scope_id,
)))
}
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(io::ErrorKind::InvalidInput.into()),
}
}
</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>