| <!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/h2-0.3.19/src/codec/framed_read.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>framed_read.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="../../../h2/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="../../../h2/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> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::frame::{<span class="self">self</span>, Frame, Kind, Reason}; |
| <span class="kw">use </span><span class="kw">crate</span>::frame::{ |
| DEFAULT_MAX_FRAME_SIZE, DEFAULT_SETTINGS_HEADER_TABLE_SIZE, MAX_MAX_FRAME_SIZE, |
| }; |
| <span class="kw">use </span><span class="kw">crate</span>::proto::Error; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::hpack; |
| |
| <span class="kw">use </span>futures_core::Stream; |
| |
| <span class="kw">use </span>bytes::BytesMut; |
| |
| <span class="kw">use </span>std::io; |
| |
| <span class="kw">use </span>std::pin::Pin; |
| <span class="kw">use </span>std::task::{Context, Poll}; |
| <span class="kw">use </span>tokio::io::AsyncRead; |
| <span class="kw">use </span>tokio_util::codec::FramedRead <span class="kw">as </span>InnerFramedRead; |
| <span class="kw">use </span>tokio_util::codec::{LengthDelimitedCodec, LengthDelimitedCodecError}; |
| |
| <span class="comment">// 16 MB "sane default" taken from golang http2 |
| </span><span class="kw">const </span>DEFAULT_SETTINGS_MAX_HEADER_LIST_SIZE: usize = <span class="number">16 </span><< <span class="number">20</span>; |
| |
| <span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>FramedRead<T> { |
| inner: InnerFramedRead<T, LengthDelimitedCodec>, |
| |
| <span class="comment">// hpack decoder state |
| </span>hpack: hpack::Decoder, |
| |
| max_header_list_size: usize, |
| |
| partial: <span class="prelude-ty">Option</span><Partial>, |
| } |
| |
| <span class="doccomment">/// Partially loaded headers frame |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">struct </span>Partial { |
| <span class="doccomment">/// Empty frame |
| </span>frame: Continuable, |
| |
| <span class="doccomment">/// Partial header payload |
| </span>buf: BytesMut, |
| } |
| |
| <span class="attribute">#[derive(Debug)] |
| </span><span class="kw">enum </span>Continuable { |
| Headers(frame::Headers), |
| PushPromise(frame::PushPromise), |
| } |
| |
| <span class="kw">impl</span><T> FramedRead<T> { |
| <span class="kw">pub fn </span>new(inner: InnerFramedRead<T, LengthDelimitedCodec>) -> FramedRead<T> { |
| FramedRead { |
| inner, |
| hpack: hpack::Decoder::new(DEFAULT_SETTINGS_HEADER_TABLE_SIZE), |
| max_header_list_size: DEFAULT_SETTINGS_MAX_HEADER_LIST_SIZE, |
| partial: <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>T { |
| <span class="self">self</span>.inner.get_ref() |
| } |
| |
| <span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>T { |
| <span class="self">self</span>.inner.get_mut() |
| } |
| |
| <span class="doccomment">/// Returns the current max frame size setting |
| </span><span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| #[inline] |
| </span><span class="kw">pub fn </span>max_frame_size(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.inner.decoder().max_frame_length() |
| } |
| |
| <span class="doccomment">/// Updates the max frame size setting. |
| /// |
| /// Must be within 16,384 and 16,777,215. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_max_frame_size(<span class="kw-2">&mut </span><span class="self">self</span>, val: usize) { |
| <span class="macro">assert!</span>(DEFAULT_MAX_FRAME_SIZE <span class="kw">as </span>usize <= val && val <= MAX_MAX_FRAME_SIZE <span class="kw">as </span>usize); |
| <span class="self">self</span>.inner.decoder_mut().set_max_frame_length(val) |
| } |
| |
| <span class="doccomment">/// Update the max header list size setting. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_max_header_list_size(<span class="kw-2">&mut </span><span class="self">self</span>, val: usize) { |
| <span class="self">self</span>.max_header_list_size = val; |
| } |
| } |
| |
| <span class="doccomment">/// Decodes a frame. |
| /// |
| /// This method is intentionally de-generified and outlined because it is very large. |
| </span><span class="kw">fn </span>decode_frame( |
| hpack: <span class="kw-2">&mut </span>hpack::Decoder, |
| max_header_list_size: usize, |
| partial_inout: <span class="kw-2">&mut </span><span class="prelude-ty">Option</span><Partial>, |
| <span class="kw-2">mut </span>bytes: BytesMut, |
| ) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><Frame>, Error> { |
| <span class="kw">let </span>span = <span class="macro">tracing::trace_span!</span>(<span class="string">"FramedRead::decode_frame"</span>, offset = bytes.len()); |
| <span class="kw">let </span>_e = span.enter(); |
| |
| <span class="macro">tracing::trace!</span>(<span class="string">"decoding frame from {}B"</span>, bytes.len()); |
| |
| <span class="comment">// Parse the head |
| </span><span class="kw">let </span>head = frame::Head::parse(<span class="kw-2">&</span>bytes); |
| |
| <span class="kw">if </span>partial_inout.is_some() && head.kind() != Kind::Continuation { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"expected CONTINUATION, got {:?}"</span>, head.kind()); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::PROTOCOL_ERROR)); |
| } |
| |
| <span class="kw">let </span>kind = head.kind(); |
| |
| <span class="macro">tracing::trace!</span>(frame.kind = <span class="question-mark">?</span>kind); |
| |
| <span class="macro">macro_rules! </span>header_block { |
| (<span class="macro-nonterminal">$frame</span>:ident, <span class="macro-nonterminal">$head</span>:ident, <span class="macro-nonterminal">$bytes</span>:ident) => ({ |
| <span class="comment">// Drop the frame header |
| // TODO: Change to drain: carllerche/bytes#130 |
| </span><span class="kw">let _ </span>= <span class="macro-nonterminal">$bytes</span>.split_to(frame::HEADER_LEN); |
| |
| <span class="comment">// Parse the header frame w/o parsing the payload |
| </span><span class="kw">let </span>(<span class="kw-2">mut </span>frame, <span class="kw-2">mut </span>payload) = <span class="kw">match </span>frame::<span class="macro-nonterminal">$frame::load</span>(<span class="macro-nonterminal">$head</span>, <span class="macro-nonterminal">$bytes</span>) { |
| <span class="prelude-val">Ok</span>(res) => res, |
| <span class="prelude-val">Err</span>(frame::Error::InvalidDependencyId) => { |
| <span class="macro">proto_err!</span>(stream: <span class="string">"invalid HEADERS dependency ID"</span>); |
| <span class="comment">// A stream cannot depend on itself. An endpoint MUST |
| // treat this as a stream error (Section 5.4.2) of type |
| // `PROTOCOL_ERROR`. |
| </span><span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_reset(<span class="macro-nonterminal">$head</span>.stream_id(), Reason::PROTOCOL_ERROR)); |
| }, |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed to load frame; err={:?}"</span>, e); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::PROTOCOL_ERROR)); |
| } |
| }; |
| |
| <span class="kw">let </span>is_end_headers = frame.is_end_headers(); |
| |
| <span class="comment">// Load the HPACK encoded headers |
| </span><span class="kw">match </span>frame.load_hpack(<span class="kw-2">&mut </span>payload, max_header_list_size, hpack) { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => {}, |
| <span class="prelude-val">Err</span>(frame::Error::Hpack(hpack::DecoderError::NeedMore(<span class="kw">_</span>))) <span class="kw">if </span>!is_end_headers => {}, |
| <span class="prelude-val">Err</span>(frame::Error::MalformedMessage) => { |
| <span class="kw">let </span>id = <span class="macro-nonterminal">$head</span>.stream_id(); |
| <span class="macro">proto_err!</span>(stream: <span class="string">"malformed header block; stream={:?}"</span>, id); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_reset(id, Reason::PROTOCOL_ERROR)); |
| }, |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed HPACK decoding; err={:?}"</span>, e); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::PROTOCOL_ERROR)); |
| } |
| } |
| |
| <span class="kw">if </span>is_end_headers { |
| frame.into() |
| } <span class="kw">else </span>{ |
| <span class="macro">tracing::trace!</span>(<span class="string">"loaded partial header block"</span>); |
| <span class="comment">// Defer returning the frame |
| </span><span class="kw-2">*</span>partial_inout = <span class="prelude-val">Some</span>(Partial { |
| frame: Continuable::<span class="macro-nonterminal">$frame</span>(frame), |
| buf: payload, |
| }); |
| |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>); |
| } |
| }); |
| } |
| |
| <span class="kw">let </span>frame = <span class="kw">match </span>kind { |
| Kind::Settings => { |
| <span class="kw">let </span>res = frame::Settings::load(head, <span class="kw-2">&</span>bytes[frame::HEADER_LEN..]); |
| |
| res.map_err(|e| { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed to load SETTINGS frame; err={:?}"</span>, e); |
| Error::library_go_away(Reason::PROTOCOL_ERROR) |
| })<span class="question-mark">? |
| </span>.into() |
| } |
| Kind::Ping => { |
| <span class="kw">let </span>res = frame::Ping::load(head, <span class="kw-2">&</span>bytes[frame::HEADER_LEN..]); |
| |
| res.map_err(|e| { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed to load PING frame; err={:?}"</span>, e); |
| Error::library_go_away(Reason::PROTOCOL_ERROR) |
| })<span class="question-mark">? |
| </span>.into() |
| } |
| Kind::WindowUpdate => { |
| <span class="kw">let </span>res = frame::WindowUpdate::load(head, <span class="kw-2">&</span>bytes[frame::HEADER_LEN..]); |
| |
| res.map_err(|e| { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed to load WINDOW_UPDATE frame; err={:?}"</span>, e); |
| Error::library_go_away(Reason::PROTOCOL_ERROR) |
| })<span class="question-mark">? |
| </span>.into() |
| } |
| Kind::Data => { |
| <span class="kw">let _ </span>= bytes.split_to(frame::HEADER_LEN); |
| <span class="kw">let </span>res = frame::Data::load(head, bytes.freeze()); |
| |
| <span class="comment">// TODO: Should this always be connection level? Probably not... |
| </span>res.map_err(|e| { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed to load DATA frame; err={:?}"</span>, e); |
| Error::library_go_away(Reason::PROTOCOL_ERROR) |
| })<span class="question-mark">? |
| </span>.into() |
| } |
| Kind::Headers => <span class="macro">header_block!</span>(Headers, head, bytes), |
| Kind::Reset => { |
| <span class="kw">let </span>res = frame::Reset::load(head, <span class="kw-2">&</span>bytes[frame::HEADER_LEN..]); |
| res.map_err(|e| { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed to load RESET frame; err={:?}"</span>, e); |
| Error::library_go_away(Reason::PROTOCOL_ERROR) |
| })<span class="question-mark">? |
| </span>.into() |
| } |
| Kind::GoAway => { |
| <span class="kw">let </span>res = frame::GoAway::load(<span class="kw-2">&</span>bytes[frame::HEADER_LEN..]); |
| res.map_err(|e| { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed to load GO_AWAY frame; err={:?}"</span>, e); |
| Error::library_go_away(Reason::PROTOCOL_ERROR) |
| })<span class="question-mark">? |
| </span>.into() |
| } |
| Kind::PushPromise => <span class="macro">header_block!</span>(PushPromise, head, bytes), |
| Kind::Priority => { |
| <span class="kw">if </span>head.stream_id() == <span class="number">0 </span>{ |
| <span class="comment">// Invalid stream identifier |
| </span><span class="macro">proto_err!</span>(conn: <span class="string">"invalid stream ID 0"</span>); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::PROTOCOL_ERROR)); |
| } |
| |
| <span class="kw">match </span>frame::Priority::load(head, <span class="kw-2">&</span>bytes[frame::HEADER_LEN..]) { |
| <span class="prelude-val">Ok</span>(frame) => frame.into(), |
| <span class="prelude-val">Err</span>(frame::Error::InvalidDependencyId) => { |
| <span class="comment">// A stream cannot depend on itself. An endpoint MUST |
| // treat this as a stream error (Section 5.4.2) of type |
| // `PROTOCOL_ERROR`. |
| </span><span class="kw">let </span>id = head.stream_id(); |
| <span class="macro">proto_err!</span>(stream: <span class="string">"PRIORITY invalid dependency ID; stream={:?}"</span>, id); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_reset(id, Reason::PROTOCOL_ERROR)); |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed to load PRIORITY frame; err={:?};"</span>, e); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::PROTOCOL_ERROR)); |
| } |
| } |
| } |
| Kind::Continuation => { |
| <span class="kw">let </span>is_end_headers = (head.flag() & <span class="number">0x4</span>) == <span class="number">0x4</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>partial = <span class="kw">match </span>partial_inout.take() { |
| <span class="prelude-val">Some</span>(partial) => partial, |
| <span class="prelude-val">None </span>=> { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"received unexpected CONTINUATION frame"</span>); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::PROTOCOL_ERROR)); |
| } |
| }; |
| |
| <span class="comment">// The stream identifiers must match |
| </span><span class="kw">if </span>partial.frame.stream_id() != head.stream_id() { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"CONTINUATION frame stream ID does not match previous frame stream ID"</span>); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::PROTOCOL_ERROR)); |
| } |
| |
| <span class="comment">// Extend the buf |
| </span><span class="kw">if </span>partial.buf.is_empty() { |
| partial.buf = bytes.split_off(frame::HEADER_LEN); |
| } <span class="kw">else </span>{ |
| <span class="kw">if </span>partial.frame.is_over_size() { |
| <span class="comment">// If there was left over bytes previously, they may be |
| // needed to continue decoding, even though we will |
| // be ignoring this frame. This is done to keep the HPACK |
| // decoder state up-to-date. |
| // |
| // Still, we need to be careful, because if a malicious |
| // attacker were to try to send a gigantic string, such |
| // that it fits over multiple header blocks, we could |
| // grow memory uncontrollably again, and that'd be a shame. |
| // |
| // Instead, we use a simple heuristic to determine if |
| // we should continue to ignore decoding, or to tell |
| // the attacker to go away. |
| </span><span class="kw">if </span>partial.buf.len() + bytes.len() > max_header_list_size { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"CONTINUATION frame header block size over ignorable limit"</span>); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::COMPRESSION_ERROR)); |
| } |
| } |
| partial.buf.extend_from_slice(<span class="kw-2">&</span>bytes[frame::HEADER_LEN..]); |
| } |
| |
| <span class="kw">match </span>partial |
| .frame |
| .load_hpack(<span class="kw-2">&mut </span>partial.buf, max_header_list_size, hpack) |
| { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => {} |
| <span class="prelude-val">Err</span>(frame::Error::Hpack(hpack::DecoderError::NeedMore(<span class="kw">_</span>))) <span class="kw">if </span>!is_end_headers => {} |
| <span class="prelude-val">Err</span>(frame::Error::MalformedMessage) => { |
| <span class="kw">let </span>id = head.stream_id(); |
| <span class="macro">proto_err!</span>(stream: <span class="string">"malformed CONTINUATION frame; stream={:?}"</span>, id); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_reset(id, Reason::PROTOCOL_ERROR)); |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="macro">proto_err!</span>(conn: <span class="string">"failed HPACK decoding; err={:?}"</span>, e); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::PROTOCOL_ERROR)); |
| } |
| } |
| |
| <span class="kw">if </span>is_end_headers { |
| partial.frame.into() |
| } <span class="kw">else </span>{ |
| <span class="kw-2">*</span>partial_inout = <span class="prelude-val">Some</span>(partial); |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>); |
| } |
| } |
| Kind::Unknown => { |
| <span class="comment">// Unknown frames are ignored |
| </span><span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>); |
| } |
| }; |
| |
| <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(frame)) |
| } |
| |
| <span class="kw">impl</span><T> Stream <span class="kw">for </span>FramedRead<T> |
| <span class="kw">where |
| </span>T: AsyncRead + Unpin, |
| { |
| <span class="kw">type </span>Item = <span class="prelude-ty">Result</span><Frame, Error>; |
| |
| <span class="kw">fn </span>poll_next(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Option</span><<span class="self">Self</span>::Item>> { |
| <span class="kw">let </span>span = <span class="macro">tracing::trace_span!</span>(<span class="string">"FramedRead::poll_next"</span>); |
| <span class="kw">let </span>_e = span.enter(); |
| <span class="kw">loop </span>{ |
| <span class="macro">tracing::trace!</span>(<span class="string">"poll"</span>); |
| <span class="kw">let </span>bytes = <span class="kw">match </span><span class="macro">ready!</span>(Pin::new(<span class="kw-2">&mut </span><span class="self">self</span>.inner).poll_next(cx)) { |
| <span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(bytes)) => bytes, |
| <span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(e)) => <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(map_err(e)))), |
| <span class="prelude-val">None </span>=> <span class="kw">return </span>Poll::Ready(<span class="prelude-val">None</span>), |
| }; |
| |
| <span class="macro">tracing::trace!</span>(read.bytes = bytes.len()); |
| <span class="kw">let </span><span class="self">Self </span>{ |
| <span class="kw-2">ref mut </span>hpack, |
| max_header_list_size, |
| <span class="kw-2">ref mut </span>partial, |
| .. |
| } = <span class="kw-2">*</span><span class="self">self</span>; |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(frame) = decode_frame(hpack, max_header_list_size, partial, bytes)<span class="question-mark">? </span>{ |
| <span class="macro">tracing::debug!</span>(<span class="question-mark">?</span>frame, <span class="string">"received"</span>); |
| <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(frame))); |
| } |
| } |
| } |
| } |
| |
| <span class="kw">fn </span>map_err(err: io::Error) -> Error { |
| <span class="kw">if let </span>io::ErrorKind::InvalidData = err.kind() { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(custom) = err.get_ref() { |
| <span class="kw">if </span>custom.is::<LengthDelimitedCodecError>() { |
| <span class="kw">return </span>Error::library_go_away(Reason::FRAME_SIZE_ERROR); |
| } |
| } |
| } |
| err.into() |
| } |
| |
| <span class="comment">// ===== impl Continuable ===== |
| |
| </span><span class="kw">impl </span>Continuable { |
| <span class="kw">fn </span>stream_id(<span class="kw-2">&</span><span class="self">self</span>) -> frame::StreamId { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| Continuable::Headers(<span class="kw-2">ref </span>h) => h.stream_id(), |
| Continuable::PushPromise(<span class="kw-2">ref </span>p) => p.stream_id(), |
| } |
| } |
| |
| <span class="kw">fn </span>is_over_size(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| Continuable::Headers(<span class="kw-2">ref </span>h) => h.is_over_size(), |
| Continuable::PushPromise(<span class="kw-2">ref </span>p) => p.is_over_size(), |
| } |
| } |
| |
| <span class="kw">fn </span>load_hpack( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| src: <span class="kw-2">&mut </span>BytesMut, |
| max_header_list_size: usize, |
| decoder: <span class="kw-2">&mut </span>hpack::Decoder, |
| ) -> <span class="prelude-ty">Result</span><(), frame::Error> { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| Continuable::Headers(<span class="kw-2">ref mut </span>h) => h.load_hpack(src, max_header_list_size, decoder), |
| Continuable::PushPromise(<span class="kw-2">ref mut </span>p) => p.load_hpack(src, max_header_list_size, decoder), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> From<Continuable> <span class="kw">for </span>Frame<T> { |
| <span class="kw">fn </span>from(cont: Continuable) -> <span class="self">Self </span>{ |
| <span class="kw">match </span>cont { |
| Continuable::Headers(<span class="kw-2">mut </span>headers) => { |
| headers.set_end_headers(); |
| headers.into() |
| } |
| Continuable::PushPromise(<span class="kw-2">mut </span>push) => { |
| push.set_end_headers(); |
| push.into() |
| } |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="h2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
