blob: fdc15181be7252d9dad49dff2047eb5e91604839 [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 `quiche/src/recovery/delivery_rate.rs`."><title>delivery_rate.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-b21aa549bf6d91ff.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="quiche" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (79734f1db 2024-05-02)" data-channel="nightly" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-e32f0c247825364d.js"></script><script defer src="../../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-09095024cf37855e.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../quiche/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
<a href="#180" id="180">180</a>
<a href="#181" id="181">181</a>
<a href="#182" id="182">182</a>
<a href="#183" id="183">183</a>
<a href="#184" id="184">184</a>
<a href="#185" id="185">185</a>
<a href="#186" id="186">186</a>
<a href="#187" id="187">187</a>
<a href="#188" id="188">188</a>
<a href="#189" id="189">189</a>
<a href="#190" id="190">190</a>
<a href="#191" id="191">191</a>
<a href="#192" id="192">192</a>
<a href="#193" id="193">193</a>
<a href="#194" id="194">194</a>
<a href="#195" id="195">195</a>
<a href="#196" id="196">196</a>
<a href="#197" id="197">197</a>
<a href="#198" id="198">198</a>
<a href="#199" id="199">199</a>
<a href="#200" id="200">200</a>
<a href="#201" id="201">201</a>
<a href="#202" id="202">202</a>
<a href="#203" id="203">203</a>
<a href="#204" id="204">204</a>
<a href="#205" id="205">205</a>
<a href="#206" id="206">206</a>
<a href="#207" id="207">207</a>
<a href="#208" id="208">208</a>
<a href="#209" id="209">209</a>
<a href="#210" id="210">210</a>
<a href="#211" id="211">211</a>
<a href="#212" id="212">212</a>
<a href="#213" id="213">213</a>
<a href="#214" id="214">214</a>
<a href="#215" id="215">215</a>
<a href="#216" id="216">216</a>
<a href="#217" id="217">217</a>
<a href="#218" id="218">218</a>
<a href="#219" id="219">219</a>
<a href="#220" id="220">220</a>
<a href="#221" id="221">221</a>
<a href="#222" id="222">222</a>
<a href="#223" id="223">223</a>
<a href="#224" id="224">224</a>
<a href="#225" id="225">225</a>
<a href="#226" id="226">226</a>
<a href="#227" id="227">227</a>
<a href="#228" id="228">228</a>
<a href="#229" id="229">229</a>
<a href="#230" id="230">230</a>
<a href="#231" id="231">231</a>
<a href="#232" id="232">232</a>
<a href="#233" id="233">233</a>
<a href="#234" id="234">234</a>
<a href="#235" id="235">235</a>
<a href="#236" id="236">236</a>
<a href="#237" id="237">237</a>
<a href="#238" id="238">238</a>
<a href="#239" id="239">239</a>
<a href="#240" id="240">240</a>
<a href="#241" id="241">241</a>
<a href="#242" id="242">242</a>
<a href="#243" id="243">243</a>
<a href="#244" id="244">244</a>
<a href="#245" id="245">245</a>
<a href="#246" id="246">246</a>
<a href="#247" id="247">247</a>
<a href="#248" id="248">248</a>
<a href="#249" id="249">249</a>
<a href="#250" id="250">250</a>
<a href="#251" id="251">251</a>
<a href="#252" id="252">252</a>
<a href="#253" id="253">253</a>
<a href="#254" id="254">254</a>
<a href="#255" id="255">255</a>
<a href="#256" id="256">256</a>
<a href="#257" id="257">257</a>
<a href="#258" id="258">258</a>
<a href="#259" id="259">259</a>
<a href="#260" id="260">260</a>
<a href="#261" id="261">261</a>
<a href="#262" id="262">262</a>
<a href="#263" id="263">263</a>
<a href="#264" id="264">264</a>
<a href="#265" id="265">265</a>
<a href="#266" id="266">266</a>
<a href="#267" id="267">267</a>
<a href="#268" id="268">268</a>
<a href="#269" id="269">269</a>
<a href="#270" id="270">270</a>
<a href="#271" id="271">271</a>
<a href="#272" id="272">272</a>
<a href="#273" id="273">273</a>
<a href="#274" id="274">274</a>
<a href="#275" id="275">275</a>
<a href="#276" id="276">276</a>
<a href="#277" id="277">277</a>
<a href="#278" id="278">278</a>
<a href="#279" id="279">279</a>
<a href="#280" id="280">280</a>
<a href="#281" id="281">281</a>
<a href="#282" id="282">282</a>
<a href="#283" id="283">283</a>
<a href="#284" id="284">284</a>
<a href="#285" id="285">285</a>
<a href="#286" id="286">286</a>
<a href="#287" id="287">287</a>
<a href="#288" id="288">288</a>
<a href="#289" id="289">289</a>
<a href="#290" id="290">290</a>
<a href="#291" id="291">291</a>
<a href="#292" id="292">292</a>
<a href="#293" id="293">293</a>
<a href="#294" id="294">294</a>
<a href="#295" id="295">295</a>
<a href="#296" id="296">296</a>
<a href="#297" id="297">297</a>
<a href="#298" id="298">298</a>
<a href="#299" id="299">299</a>
<a href="#300" id="300">300</a>
<a href="#301" id="301">301</a>
<a href="#302" id="302">302</a>
<a href="#303" id="303">303</a>
<a href="#304" id="304">304</a>
<a href="#305" id="305">305</a>
<a href="#306" id="306">306</a>
<a href="#307" id="307">307</a>
<a href="#308" id="308">308</a>
<a href="#309" id="309">309</a>
<a href="#310" id="310">310</a>
<a href="#311" id="311">311</a>
<a href="#312" id="312">312</a>
<a href="#313" id="313">313</a>
<a href="#314" id="314">314</a>
<a href="#315" id="315">315</a>
<a href="#316" id="316">316</a>
<a href="#317" id="317">317</a>
<a href="#318" id="318">318</a>
<a href="#319" id="319">319</a>
<a href="#320" id="320">320</a>
<a href="#321" id="321">321</a>
<a href="#322" id="322">322</a>
<a href="#323" id="323">323</a>
<a href="#324" id="324">324</a>
<a href="#325" id="325">325</a>
<a href="#326" id="326">326</a>
<a href="#327" id="327">327</a>
<a href="#328" id="328">328</a>
<a href="#329" id="329">329</a>
<a href="#330" id="330">330</a>
<a href="#331" id="331">331</a>
<a href="#332" id="332">332</a>
<a href="#333" id="333">333</a>
<a href="#334" id="334">334</a>
<a href="#335" id="335">335</a>
<a href="#336" id="336">336</a>
<a href="#337" id="337">337</a>
<a href="#338" id="338">338</a>
<a href="#339" id="339">339</a>
<a href="#340" id="340">340</a>
<a href="#341" id="341">341</a>
<a href="#342" id="342">342</a>
<a href="#343" id="343">343</a>
<a href="#344" id="344">344</a>
<a href="#345" id="345">345</a>
<a href="#346" id="346">346</a>
<a href="#347" id="347">347</a>
<a href="#348" id="348">348</a>
<a href="#349" id="349">349</a>
<a href="#350" id="350">350</a>
<a href="#351" id="351">351</a>
<a href="#352" id="352">352</a>
<a href="#353" id="353">353</a>
<a href="#354" id="354">354</a>
<a href="#355" id="355">355</a>
<a href="#356" id="356">356</a>
<a href="#357" id="357">357</a>
<a href="#358" id="358">358</a>
<a href="#359" id="359">359</a>
<a href="#360" id="360">360</a>
<a href="#361" id="361">361</a>
<a href="#362" id="362">362</a>
<a href="#363" id="363">363</a>
<a href="#364" id="364">364</a>
<a href="#365" id="365">365</a>
<a href="#366" id="366">366</a>
<a href="#367" id="367">367</a>
<a href="#368" id="368">368</a>
<a href="#369" id="369">369</a>
<a href="#370" id="370">370</a>
<a href="#371" id="371">371</a>
<a href="#372" id="372">372</a>
<a href="#373" id="373">373</a>
<a href="#374" id="374">374</a>
<a href="#375" id="375">375</a>
<a href="#376" id="376">376</a>
<a href="#377" id="377">377</a>
<a href="#378" id="378">378</a>
<a href="#379" id="379">379</a>
<a href="#380" id="380">380</a>
<a href="#381" id="381">381</a>
<a href="#382" id="382">382</a>
<a href="#383" id="383">383</a>
<a href="#384" id="384">384</a>
<a href="#385" id="385">385</a>
<a href="#386" id="386">386</a>
<a href="#387" id="387">387</a>
<a href="#388" id="388">388</a>
<a href="#389" id="389">389</a>
<a href="#390" id="390">390</a>
<a href="#391" id="391">391</a>
<a href="#392" id="392">392</a>
<a href="#393" id="393">393</a>
<a href="#394" id="394">394</a>
</pre></div><pre class="rust"><code><span class="comment">// Copyright (C) 2020-2022, Cloudflare, Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</span><span class="doccomment">//! Delivery rate estimation.
//!
//! This implements the algorithm for estimating delivery rate as described in
//! &lt;https://tools.ietf.org/html/draft-cheng-iccrg-delivery-rate-estimation-01&gt;
</span><span class="kw">use </span>std::time::Duration;
<span class="kw">use </span>std::time::Instant;
<span class="kw">use </span><span class="kw">crate</span>::recovery::Acked;
<span class="kw">use </span><span class="kw">crate</span>::recovery::Sent;
<span class="attr">#[derive(Debug)]
</span><span class="kw">pub struct </span>Rate {
delivered: usize,
delivered_time: Instant,
first_sent_time: Instant,
<span class="comment">// Packet number of the last sent packet with app limited.
</span>end_of_app_limited: u64,
<span class="comment">// Packet number of the last sent packet.
</span>last_sent_packet: u64,
<span class="comment">// Packet number of the largest acked packet.
</span>largest_acked: u64,
<span class="comment">// Sample of rate estimation.
</span>rate_sample: RateSample,
}
<span class="kw">impl </span>Default <span class="kw">for </span>Rate {
<span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<span class="kw">let </span>now = Instant::now();
Rate {
delivered: <span class="number">0</span>,
delivered_time: now,
first_sent_time: now,
end_of_app_limited: <span class="number">0</span>,
last_sent_packet: <span class="number">0</span>,
largest_acked: <span class="number">0</span>,
rate_sample: RateSample::default(),
}
}
}
<span class="kw">impl </span>Rate {
<span class="kw">pub fn </span>on_packet_sent(
<span class="kw-2">&amp;mut </span><span class="self">self</span>, pkt: <span class="kw-2">&amp;mut </span>Sent, bytes_in_flight: usize, bytes_lost: u64,
) {
<span class="comment">// No packets in flight.
</span><span class="kw">if </span>bytes_in_flight == <span class="number">0 </span>{
<span class="self">self</span>.first_sent_time = pkt.time_sent;
<span class="self">self</span>.delivered_time = pkt.time_sent;
}
pkt.first_sent_time = <span class="self">self</span>.first_sent_time;
pkt.delivered_time = <span class="self">self</span>.delivered_time;
pkt.delivered = <span class="self">self</span>.delivered;
pkt.is_app_limited = <span class="self">self</span>.app_limited();
pkt.tx_in_flight = bytes_in_flight;
pkt.lost = bytes_lost;
<span class="self">self</span>.last_sent_packet = pkt.pkt_num;
}
<span class="comment">// Update the delivery rate sample when a packet is acked.
</span><span class="kw">pub fn </span>update_rate_sample(<span class="kw-2">&amp;mut </span><span class="self">self</span>, pkt: <span class="kw-2">&amp;</span>Acked, now: Instant) {
<span class="self">self</span>.delivered += pkt.size;
<span class="self">self</span>.delivered_time = now;
<span class="comment">// Update info using the newest packet. If rate_sample is not yet
// initialized, initialize with the first packet.
</span><span class="kw">if </span><span class="self">self</span>.rate_sample.prior_time.is_none() ||
pkt.delivered &gt; <span class="self">self</span>.rate_sample.prior_delivered
{
<span class="self">self</span>.rate_sample.prior_delivered = pkt.delivered;
<span class="self">self</span>.rate_sample.prior_time = <span class="prelude-val">Some</span>(pkt.delivered_time);
<span class="self">self</span>.rate_sample.is_app_limited = pkt.is_app_limited;
<span class="self">self</span>.rate_sample.send_elapsed =
pkt.time_sent.saturating_duration_since(pkt.first_sent_time);
<span class="self">self</span>.rate_sample.rtt = pkt.rtt;
<span class="self">self</span>.rate_sample.ack_elapsed = <span class="self">self
</span>.delivered_time
.saturating_duration_since(pkt.delivered_time);
<span class="self">self</span>.first_sent_time = pkt.time_sent;
}
<span class="self">self</span>.largest_acked = <span class="self">self</span>.largest_acked.max(pkt.pkt_num);
}
<span class="kw">pub fn </span>generate_rate_sample(<span class="kw-2">&amp;mut </span><span class="self">self</span>, min_rtt: Duration) {
<span class="comment">// End app-limited phase if bubble is ACKed and gone.
</span><span class="kw">if </span><span class="self">self</span>.app_limited() &amp;&amp; <span class="self">self</span>.largest_acked &gt; <span class="self">self</span>.end_of_app_limited {
<span class="self">self</span>.update_app_limited(<span class="bool-val">false</span>);
}
<span class="kw">if </span><span class="self">self</span>.rate_sample.prior_time.is_some() {
<span class="kw">let </span>interval = <span class="self">self
</span>.rate_sample
.send_elapsed
.max(<span class="self">self</span>.rate_sample.ack_elapsed);
<span class="self">self</span>.rate_sample.delivered =
<span class="self">self</span>.delivered - <span class="self">self</span>.rate_sample.prior_delivered;
<span class="self">self</span>.rate_sample.interval = interval;
<span class="kw">if </span>interval &lt; min_rtt {
<span class="self">self</span>.rate_sample.interval = Duration::ZERO;
<span class="comment">// No reliable sample.
</span><span class="kw">return</span>;
}
<span class="kw">if </span>!interval.is_zero() {
<span class="comment">// Fill in rate_sample with a rate sample.
</span><span class="self">self</span>.rate_sample.delivery_rate =
(<span class="self">self</span>.rate_sample.delivered <span class="kw">as </span>f64 / interval.as_secs_f64())
<span class="kw">as </span>u64;
}
}
}
<span class="kw">pub fn </span>update_app_limited(<span class="kw-2">&amp;mut </span><span class="self">self</span>, v: bool) {
<span class="self">self</span>.end_of_app_limited = <span class="kw">if </span>v { <span class="self">self</span>.last_sent_packet.max(<span class="number">1</span>) } <span class="kw">else </span>{ <span class="number">0 </span>}
}
<span class="kw">pub fn </span>app_limited(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.end_of_app_limited != <span class="number">0
</span>}
<span class="kw">pub fn </span>delivered(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.delivered
}
<span class="kw">pub fn </span>sample_delivery_rate(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.rate_sample.delivery_rate
}
<span class="kw">pub fn </span>sample_rtt(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Duration {
<span class="self">self</span>.rate_sample.rtt
}
<span class="kw">pub fn </span>sample_is_app_limited(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.rate_sample.is_app_limited
}
<span class="kw">pub fn </span>sample_delivered(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.rate_sample.delivered
}
<span class="kw">pub fn </span>sample_prior_delivered(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.rate_sample.prior_delivered
}
}
<span class="attr">#[derive(Default, Debug)]
</span><span class="kw">struct </span>RateSample {
delivery_rate: u64,
is_app_limited: bool,
interval: Duration,
delivered: usize,
prior_delivered: usize,
prior_time: <span class="prelude-ty">Option</span>&lt;Instant&gt;,
send_elapsed: Duration,
ack_elapsed: Duration,
rtt: Duration,
}
<span class="attr">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::recovery::<span class="kw-2">*</span>;
<span class="kw">use </span>smallvec::smallvec;
<span class="attr">#[test]
</span><span class="kw">fn </span>rate_check() {
<span class="kw">let </span>config = Config::new(<span class="number">0xbabababa</span>).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>r = Recovery::new(<span class="kw-2">&amp;</span>config);
<span class="kw">let </span>now = Instant::now();
<span class="kw">let </span>mss = r.max_datagram_size();
<span class="comment">// Send 2 packets.
</span><span class="kw">for </span>pn <span class="kw">in </span><span class="number">0</span>..<span class="number">2 </span>{
<span class="kw">let </span>pkt = Sent {
pkt_num: pn,
frames: <span class="macro">smallvec!</span>[],
time_sent: now,
time_acked: <span class="prelude-val">None</span>,
time_lost: <span class="prelude-val">None</span>,
size: mss,
ack_eliciting: <span class="bool-val">true</span>,
in_flight: <span class="bool-val">true</span>,
delivered: <span class="number">0</span>,
delivered_time: now,
first_sent_time: now,
is_app_limited: <span class="bool-val">false</span>,
has_data: <span class="bool-val">false</span>,
tx_in_flight: <span class="number">0</span>,
lost: <span class="number">0</span>,
pmtud: <span class="bool-val">false</span>,
};
r.on_packet_sent(
pkt,
packet::Epoch::Application,
HandshakeStatus::default(),
now,
<span class="string">""</span>,
);
}
<span class="kw">let </span>rtt = Duration::from_millis(<span class="number">50</span>);
<span class="kw">let </span>now = now + rtt;
<span class="comment">// Ack 2 packets.
</span><span class="kw">for </span>pn <span class="kw">in </span><span class="number">0</span>..<span class="number">2 </span>{
<span class="kw">let </span>acked = Acked {
pkt_num: pn,
time_sent: now,
size: mss,
rtt,
delivered: <span class="number">0</span>,
delivered_time: now,
first_sent_time: now.checked_sub(rtt).unwrap(),
is_app_limited: <span class="bool-val">false</span>,
tx_in_flight: <span class="number">0</span>,
lost: <span class="number">0</span>,
};
r.delivery_rate.update_rate_sample(<span class="kw-2">&amp;</span>acked, now);
}
<span class="comment">// Update rate sample after 1 rtt.
</span>r.delivery_rate.generate_rate_sample(rtt);
<span class="comment">// Bytes acked so far.
</span><span class="macro">assert_eq!</span>(r.delivery_rate.delivered(), <span class="number">2400</span>);
<span class="comment">// Estimated delivery rate = (1200 x 2) / 0.05s = 48000.
</span><span class="macro">assert_eq!</span>(r.delivery_rate(), <span class="number">48000</span>);
}
<span class="attr">#[test]
</span><span class="kw">fn </span>app_limited_cwnd_full() {
<span class="kw">let </span>config = Config::new(<span class="number">0xbabababa</span>).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>r = Recovery::new(<span class="kw-2">&amp;</span>config);
<span class="kw">let </span>now = Instant::now();
<span class="kw">let </span>mss = r.max_datagram_size();
<span class="comment">// Send 10 packets to fill cwnd.
</span><span class="kw">for </span>pn <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{
<span class="kw">let </span>pkt = Sent {
pkt_num: pn,
frames: <span class="macro">smallvec!</span>[],
time_sent: now,
time_acked: <span class="prelude-val">None</span>,
time_lost: <span class="prelude-val">None</span>,
size: mss,
ack_eliciting: <span class="bool-val">true</span>,
in_flight: <span class="bool-val">true</span>,
delivered: <span class="number">0</span>,
delivered_time: now,
first_sent_time: now,
is_app_limited: <span class="bool-val">false</span>,
has_data: <span class="bool-val">false</span>,
tx_in_flight: <span class="number">0</span>,
lost: <span class="number">0</span>,
pmtud: <span class="bool-val">false</span>,
};
r.on_packet_sent(
pkt,
packet::Epoch::Application,
HandshakeStatus::default(),
now,
<span class="string">""</span>,
);
}
<span class="macro">assert!</span>(!r.app_limited());
<span class="macro">assert!</span>(!r.delivery_rate.sample_is_app_limited());
}
<span class="attr">#[test]
</span><span class="kw">fn </span>app_limited_check() {
<span class="kw">let </span>config = Config::new(<span class="number">0xbabababa</span>).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>r = Recovery::new(<span class="kw-2">&amp;</span>config);
<span class="kw">let </span>now = Instant::now();
<span class="kw">let </span>mss = r.max_datagram_size();
<span class="comment">// Send 5 packets.
</span><span class="kw">for </span>pn <span class="kw">in </span><span class="number">0</span>..<span class="number">5 </span>{
<span class="kw">let </span>pkt = Sent {
pkt_num: pn,
frames: <span class="macro">smallvec!</span>[],
time_sent: now,
time_acked: <span class="prelude-val">None</span>,
time_lost: <span class="prelude-val">None</span>,
size: mss,
ack_eliciting: <span class="bool-val">true</span>,
in_flight: <span class="bool-val">true</span>,
delivered: <span class="number">0</span>,
delivered_time: now,
first_sent_time: now,
is_app_limited: <span class="bool-val">false</span>,
has_data: <span class="bool-val">false</span>,
tx_in_flight: <span class="number">0</span>,
lost: <span class="number">0</span>,
pmtud: <span class="bool-val">false</span>,
};
r.on_packet_sent(
pkt,
packet::Epoch::Application,
HandshakeStatus::default(),
now,
<span class="string">""</span>,
);
}
<span class="kw">let </span>rtt = Duration::from_millis(<span class="number">50</span>);
<span class="kw">let </span>now = now + rtt;
<span class="kw">let </span><span class="kw-2">mut </span>acked = ranges::RangeSet::default();
acked.insert(<span class="number">0</span>..<span class="number">5</span>);
<span class="macro">assert_eq!</span>(
r.on_ack_received(
<span class="kw-2">&amp;</span>acked,
<span class="number">25</span>,
packet::Epoch::Application,
HandshakeStatus::default(),
now,
<span class="string">""</span>,
<span class="kw-2">&amp;mut </span>Vec::new(),
),
<span class="prelude-val">Ok</span>((<span class="number">0</span>, <span class="number">0</span>)),
);
<span class="macro">assert!</span>(r.app_limited());
<span class="comment">// Rate sample is not app limited (all acked).
</span><span class="macro">assert!</span>(!r.delivery_rate.sample_is_app_limited());
<span class="macro">assert_eq!</span>(r.delivery_rate.sample_rtt(), rtt);
}
}
</code></pre></div></section></main></body></html>