blob: ee573cf0c7acfdccbc264d0a9a651bcff5041c7a [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/registry/src/github.com-1ecc6299db9ec823/h2-0.3.19/src/proto/streams/flow_control.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>flow_control.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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::frame::Reason;
<span class="kw">use </span><span class="kw">crate</span>::proto::{WindowSize, MAX_WINDOW_SIZE};
<span class="kw">use </span>std::fmt;
<span class="comment">// We don&#39;t want to send WINDOW_UPDATE frames for tiny changes, but instead
// aggregate them when the changes are significant. Many implementations do
// this by keeping a &quot;ratio&quot; of the update version the allowed window size.
//
// While some may wish to represent this ratio as percentage, using a f32,
// we skip having to deal with float math and stick to integers. To do so,
// the &quot;ratio&quot; is represented by 2 i32s, split into the numerator and
// denominator. For example, a 50% ratio is simply represented as 1/2.
//
// An example applying this ratio: If a stream has an allowed window size of
// 100 bytes, WINDOW_UPDATE frames are scheduled when the unclaimed change
// becomes greater than 1/2, or 50 bytes.
</span><span class="kw">const </span>UNCLAIMED_NUMERATOR: i32 = <span class="number">1</span>;
<span class="kw">const </span>UNCLAIMED_DENOMINATOR: i32 = <span class="number">2</span>;
<span class="attribute">#[test]
#[allow(clippy::assertions_on_constants)]
</span><span class="kw">fn </span>sanity_unclaimed_ratio() {
<span class="macro">assert!</span>(UNCLAIMED_NUMERATOR &lt; UNCLAIMED_DENOMINATOR);
<span class="macro">assert!</span>(UNCLAIMED_NUMERATOR &gt;= <span class="number">0</span>);
<span class="macro">assert!</span>(UNCLAIMED_DENOMINATOR &gt; <span class="number">0</span>);
}
<span class="attribute">#[derive(Copy, Clone, Debug)]
</span><span class="kw">pub struct </span>FlowControl {
<span class="doccomment">/// Window the peer knows about.
///
/// This can go negative if a SETTINGS_INITIAL_WINDOW_SIZE is received.
///
/// For example, say the peer sends a request and uses 32kb of the window.
/// We send a SETTINGS_INITIAL_WINDOW_SIZE of 16kb. The peer has to adjust
/// its understanding of the capacity of the window, and that would be:
///
/// ```notrust
/// default (64kb) - used (32kb) - settings_diff (64kb - 16kb): -16kb
/// ```
</span>window_size: Window,
<span class="doccomment">/// Window that we know about.
///
/// This can go negative if a user declares a smaller target window than
/// the peer knows about.
</span>available: Window,
}
<span class="kw">impl </span>FlowControl {
<span class="kw">pub fn </span>new() -&gt; FlowControl {
FlowControl {
window_size: Window(<span class="number">0</span>),
available: Window(<span class="number">0</span>),
}
}
<span class="doccomment">/// Returns the window size as known by the peer
</span><span class="kw">pub fn </span>window_size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; WindowSize {
<span class="self">self</span>.window_size.as_size()
}
<span class="doccomment">/// Returns the window size available to the consumer
</span><span class="kw">pub fn </span>available(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Window {
<span class="self">self</span>.available
}
<span class="doccomment">/// Returns true if there is unavailable window capacity
</span><span class="kw">pub fn </span>has_unavailable(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="kw">if </span><span class="self">self</span>.window_size &lt; <span class="number">0 </span>{
<span class="kw">return </span><span class="bool-val">false</span>;
}
<span class="self">self</span>.window_size &gt; <span class="self">self</span>.available
}
<span class="kw">pub fn </span>claim_capacity(<span class="kw-2">&amp;mut </span><span class="self">self</span>, capacity: WindowSize) {
<span class="self">self</span>.available -= capacity;
}
<span class="kw">pub fn </span>assign_capacity(<span class="kw-2">&amp;mut </span><span class="self">self</span>, capacity: WindowSize) {
<span class="self">self</span>.available += capacity;
}
<span class="doccomment">/// If a WINDOW_UPDATE frame should be sent, returns a positive number
/// representing the increment to be used.
///
/// If there is no available bytes to be reclaimed, or the number of
/// available bytes does not reach the threshold, this returns `None`.
///
/// This represents pending outbound WINDOW_UPDATE frames.
</span><span class="kw">pub fn </span>unclaimed_capacity(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;WindowSize&gt; {
<span class="kw">let </span>available = <span class="self">self</span>.available;
<span class="kw">if </span><span class="self">self</span>.window_size &gt;= available {
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="kw">let </span>unclaimed = available.<span class="number">0 </span>- <span class="self">self</span>.window_size.<span class="number">0</span>;
<span class="kw">let </span>threshold = <span class="self">self</span>.window_size.<span class="number">0 </span>/ UNCLAIMED_DENOMINATOR * UNCLAIMED_NUMERATOR;
<span class="kw">if </span>unclaimed &lt; threshold {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="prelude-val">Some</span>(unclaimed <span class="kw">as </span>WindowSize)
}
}
<span class="doccomment">/// Increase the window size.
///
/// This is called after receiving a WINDOW_UPDATE frame
</span><span class="kw">pub fn </span>inc_window(<span class="kw-2">&amp;mut </span><span class="self">self</span>, sz: WindowSize) -&gt; <span class="prelude-ty">Result</span>&lt;(), Reason&gt; {
<span class="kw">let </span>(val, overflow) = <span class="self">self</span>.window_size.<span class="number">0</span>.overflowing_add(sz <span class="kw">as </span>i32);
<span class="kw">if </span>overflow {
<span class="kw">return </span><span class="prelude-val">Err</span>(Reason::FLOW_CONTROL_ERROR);
}
<span class="kw">if </span>val &gt; MAX_WINDOW_SIZE <span class="kw">as </span>i32 {
<span class="kw">return </span><span class="prelude-val">Err</span>(Reason::FLOW_CONTROL_ERROR);
}
<span class="macro">tracing::trace!</span>(
<span class="string">&quot;inc_window; sz={}; old={}; new={}&quot;</span>,
sz,
<span class="self">self</span>.window_size,
val
);
<span class="self">self</span>.window_size = Window(val);
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Decrement the send-side window size.
///
/// This is called after receiving a SETTINGS frame with a lower
/// INITIAL_WINDOW_SIZE value.
</span><span class="kw">pub fn </span>dec_send_window(<span class="kw-2">&amp;mut </span><span class="self">self</span>, sz: WindowSize) {
<span class="macro">tracing::trace!</span>(
<span class="string">&quot;dec_window; sz={}; window={}, available={}&quot;</span>,
sz,
<span class="self">self</span>.window_size,
<span class="self">self</span>.available
);
<span class="comment">// This should not be able to overflow `window_size` from the bottom.
</span><span class="self">self</span>.window_size -= sz;
}
<span class="doccomment">/// Decrement the recv-side window size.
///
/// This is called after receiving a SETTINGS ACK frame with a lower
/// INITIAL_WINDOW_SIZE value.
</span><span class="kw">pub fn </span>dec_recv_window(<span class="kw-2">&amp;mut </span><span class="self">self</span>, sz: WindowSize) {
<span class="macro">tracing::trace!</span>(
<span class="string">&quot;dec_recv_window; sz={}; window={}, available={}&quot;</span>,
sz,
<span class="self">self</span>.window_size,
<span class="self">self</span>.available
);
<span class="comment">// This should not be able to overflow `window_size` from the bottom.
</span><span class="self">self</span>.window_size -= sz;
<span class="self">self</span>.available -= sz;
}
<span class="doccomment">/// Decrements the window reflecting data has actually been sent. The caller
/// must ensure that the window has capacity.
</span><span class="kw">pub fn </span>send_data(<span class="kw-2">&amp;mut </span><span class="self">self</span>, sz: WindowSize) {
<span class="macro">tracing::trace!</span>(
<span class="string">&quot;send_data; sz={}; window={}; available={}&quot;</span>,
sz,
<span class="self">self</span>.window_size,
<span class="self">self</span>.available
);
<span class="comment">// If send size is zero it&#39;s meaningless to update flow control window
</span><span class="kw">if </span>sz &gt; <span class="number">0 </span>{
<span class="comment">// Ensure that the argument is correct
</span><span class="macro">assert!</span>(<span class="self">self</span>.window_size &gt;= sz <span class="kw">as </span>usize);
<span class="comment">// Update values
</span><span class="self">self</span>.window_size -= sz;
<span class="self">self</span>.available -= sz;
}
}
}
<span class="doccomment">/// The current capacity of a flow-controlled Window.
///
/// This number can go negative when either side has used a certain amount
/// of capacity when the other side advertises a reduction in size.
///
/// This type tries to centralize the knowledge of addition and subtraction
/// to this capacity, instead of having integer casts throughout the source.
</span><span class="attribute">#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd)]
</span><span class="kw">pub struct </span>Window(i32);
<span class="kw">impl </span>Window {
<span class="kw">pub fn </span>as_size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; WindowSize {
<span class="kw">if </span><span class="self">self</span>.<span class="number">0 </span>&lt; <span class="number">0 </span>{
<span class="number">0
</span>} <span class="kw">else </span>{
<span class="self">self</span>.<span class="number">0 </span><span class="kw">as </span>WindowSize
}
}
<span class="kw">pub fn </span>checked_size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; WindowSize {
<span class="macro">assert!</span>(<span class="self">self</span>.<span class="number">0 </span>&gt;= <span class="number">0</span>, <span class="string">&quot;negative Window&quot;</span>);
<span class="self">self</span>.<span class="number">0 </span><span class="kw">as </span>WindowSize
}
}
<span class="kw">impl </span>PartialEq&lt;usize&gt; <span class="kw">for </span>Window {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>usize) -&gt; bool {
<span class="kw">if </span><span class="self">self</span>.<span class="number">0 </span>&lt; <span class="number">0 </span>{
<span class="bool-val">false
</span>} <span class="kw">else </span>{
(<span class="self">self</span>.<span class="number">0 </span><span class="kw">as </span>usize).eq(other)
}
}
}
<span class="kw">impl </span>PartialOrd&lt;usize&gt; <span class="kw">for </span>Window {
<span class="kw">fn </span>partial_cmp(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>usize) -&gt; <span class="prelude-ty">Option</span>&lt;::std::cmp::Ordering&gt; {
<span class="kw">if </span><span class="self">self</span>.<span class="number">0 </span>&lt; <span class="number">0 </span>{
<span class="prelude-val">Some</span>(::std::cmp::Ordering::Less)
} <span class="kw">else </span>{
(<span class="self">self</span>.<span class="number">0 </span><span class="kw">as </span>usize).partial_cmp(other)
}
}
}
<span class="kw">impl </span>::std::ops::SubAssign&lt;WindowSize&gt; <span class="kw">for </span>Window {
<span class="kw">fn </span>sub_assign(<span class="kw-2">&amp;mut </span><span class="self">self</span>, other: WindowSize) {
<span class="self">self</span>.<span class="number">0 </span>-= other <span class="kw">as </span>i32;
}
}
<span class="kw">impl </span>::std::ops::Add&lt;WindowSize&gt; <span class="kw">for </span>Window {
<span class="kw">type </span>Output = <span class="self">Self</span>;
<span class="kw">fn </span>add(<span class="self">self</span>, other: WindowSize) -&gt; <span class="self">Self</span>::Output {
Window(<span class="self">self</span>.<span class="number">0 </span>+ other <span class="kw">as </span>i32)
}
}
<span class="kw">impl </span>::std::ops::AddAssign&lt;WindowSize&gt; <span class="kw">for </span>Window {
<span class="kw">fn </span>add_assign(<span class="kw-2">&amp;mut </span><span class="self">self</span>, other: WindowSize) {
<span class="self">self</span>.<span class="number">0 </span>+= other <span class="kw">as </span>i32;
}
}
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Window {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
fmt::Display::fmt(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, f)
}
}
<span class="kw">impl </span>From&lt;Window&gt; <span class="kw">for </span>isize {
<span class="kw">fn </span>from(w: Window) -&gt; isize {
w.<span class="number">0 </span><span class="kw">as </span>isize
}
}
</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>