mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-20 06:50:37 +00:00
279 lines
28 KiB
HTML
279 lines
28 KiB
HTML
<!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 `src/common/memory-manager/src/guard.rs`."><title>guard.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_memory_manager" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[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" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_memory_manager/</div>guard.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
|
|
<a href=#2 id=2 data-nosnippet>2</a>//
|
|
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
|
|
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
|
|
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
|
|
<a href=#6 id=6 data-nosnippet>6</a>//
|
|
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
|
|
<a href=#8 id=8 data-nosnippet>8</a>//
|
|
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
|
|
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
|
|
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
|
|
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
|
|
<a href=#14 id=14 data-nosnippet>14</a>
|
|
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::{fmt, mem};
|
|
<a href=#16 id=16 data-nosnippet>16</a>
|
|
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>snafu::ensure;
|
|
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>tokio::sync::{OwnedSemaphorePermit, TryAcquireError};
|
|
<a href=#19 id=19 data-nosnippet>19</a>
|
|
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span><span class="kw">crate</span>::error::{
|
|
<a href=#21 id=21 data-nosnippet>21</a> MemoryAcquireTimeoutSnafu, MemoryLimitExceededSnafu, MemorySemaphoreClosedSnafu, <span class="prelude-ty">Result</span>,
|
|
<a href=#22 id=22 data-nosnippet>22</a>};
|
|
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span><span class="kw">crate</span>::manager::{MemoryMetrics, MemoryQuota, UnlimitedMemoryQuota};
|
|
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span><span class="kw">crate</span>::policy::OnExhaustedPolicy;
|
|
<a href=#25 id=25 data-nosnippet>25</a>
|
|
<a href=#26 id=26 data-nosnippet>26</a><span class="doccomment">/// Guard representing a slice of reserved memory.
|
|
<a href=#27 id=27 data-nosnippet>27</a></span><span class="kw">pub struct </span>MemoryGuard<M: MemoryMetrics> {
|
|
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">pub</span>(<span class="kw">crate</span>) state: GuardState<M>,
|
|
<a href=#29 id=29 data-nosnippet>29</a>}
|
|
<a href=#30 id=30 data-nosnippet>30</a>
|
|
<a href=#31 id=31 data-nosnippet>31</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>GuardState<M: MemoryMetrics> {
|
|
<a href=#32 id=32 data-nosnippet>32</a> Released,
|
|
<a href=#33 id=33 data-nosnippet>33</a> Unlimited {
|
|
<a href=#34 id=34 data-nosnippet>34</a> quota: UnlimitedMemoryQuota<M>,
|
|
<a href=#35 id=35 data-nosnippet>35</a> granted_bytes: u64,
|
|
<a href=#36 id=36 data-nosnippet>36</a> },
|
|
<a href=#37 id=37 data-nosnippet>37</a> Limited {
|
|
<a href=#38 id=38 data-nosnippet>38</a> quota: MemoryQuota<M>,
|
|
<a href=#39 id=39 data-nosnippet>39</a> permit: OwnedSemaphorePermit,
|
|
<a href=#40 id=40 data-nosnippet>40</a> },
|
|
<a href=#41 id=41 data-nosnippet>41</a>}
|
|
<a href=#42 id=42 data-nosnippet>42</a>
|
|
<a href=#43 id=43 data-nosnippet>43</a><span class="kw">impl</span><M: MemoryMetrics> GuardState<M> {
|
|
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">fn </span>release(<span class="self">self</span>) {
|
|
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">match </span><span class="self">self </span>{
|
|
<a href=#46 id=46 data-nosnippet>46</a> GuardState::Released => {}
|
|
<a href=#47 id=47 data-nosnippet>47</a> GuardState::Unlimited {
|
|
<a href=#48 id=48 data-nosnippet>48</a> quota,
|
|
<a href=#49 id=49 data-nosnippet>49</a> granted_bytes,
|
|
<a href=#50 id=50 data-nosnippet>50</a> } => {
|
|
<a href=#51 id=51 data-nosnippet>51</a> quota.sub_in_use(granted_bytes);
|
|
<a href=#52 id=52 data-nosnippet>52</a> }
|
|
<a href=#53 id=53 data-nosnippet>53</a> GuardState::Limited { quota, permit } => {
|
|
<a href=#54 id=54 data-nosnippet>54</a> quota.release_permit(permit);
|
|
<a href=#55 id=55 data-nosnippet>55</a> }
|
|
<a href=#56 id=56 data-nosnippet>56</a> }
|
|
<a href=#57 id=57 data-nosnippet>57</a> }
|
|
<a href=#58 id=58 data-nosnippet>58</a>}
|
|
<a href=#59 id=59 data-nosnippet>59</a>
|
|
<a href=#60 id=60 data-nosnippet>60</a><span class="kw">impl</span><M: MemoryMetrics> MemoryGuard<M> {
|
|
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>unlimited(quota: UnlimitedMemoryQuota<M>, bytes: u64) -> <span class="self">Self </span>{
|
|
<a href=#62 id=62 data-nosnippet>62</a> quota.add_in_use(bytes);
|
|
<a href=#63 id=63 data-nosnippet>63</a> <span class="self">Self </span>{
|
|
<a href=#64 id=64 data-nosnippet>64</a> state: GuardState::Unlimited {
|
|
<a href=#65 id=65 data-nosnippet>65</a> quota,
|
|
<a href=#66 id=66 data-nosnippet>66</a> granted_bytes: bytes,
|
|
<a href=#67 id=67 data-nosnippet>67</a> },
|
|
<a href=#68 id=68 data-nosnippet>68</a> }
|
|
<a href=#69 id=69 data-nosnippet>69</a> }
|
|
<a href=#70 id=70 data-nosnippet>70</a>
|
|
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>limited(quota: MemoryQuota<M>, permit: OwnedSemaphorePermit) -> <span class="self">Self </span>{
|
|
<a href=#72 id=72 data-nosnippet>72</a> <span class="self">Self </span>{
|
|
<a href=#73 id=73 data-nosnippet>73</a> state: GuardState::Limited { quota, permit },
|
|
<a href=#74 id=74 data-nosnippet>74</a> }
|
|
<a href=#75 id=75 data-nosnippet>75</a> }
|
|
<a href=#76 id=76 data-nosnippet>76</a>
|
|
<a href=#77 id=77 data-nosnippet>77</a> <span class="doccomment">/// Returns granted quota in bytes.
|
|
<a href=#78 id=78 data-nosnippet>78</a> </span><span class="kw">pub fn </span>granted_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> u64 {
|
|
<a href=#79 id=79 data-nosnippet>79</a> <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.state {
|
|
<a href=#80 id=80 data-nosnippet>80</a> GuardState::Released => <span class="number">0</span>,
|
|
<a href=#81 id=81 data-nosnippet>81</a> GuardState::Unlimited { granted_bytes, .. } => <span class="kw-2">*</span>granted_bytes,
|
|
<a href=#82 id=82 data-nosnippet>82</a> GuardState::Limited { quota, permit } => {
|
|
<a href=#83 id=83 data-nosnippet>83</a> quota.permits_to_bytes(permit.num_permits() <span class="kw">as </span>u32)
|
|
<a href=#84 id=84 data-nosnippet>84</a> }
|
|
<a href=#85 id=85 data-nosnippet>85</a> }
|
|
<a href=#86 id=86 data-nosnippet>86</a> }
|
|
<a href=#87 id=87 data-nosnippet>87</a>
|
|
<a href=#88 id=88 data-nosnippet>88</a> <span class="doccomment">/// Acquires additional memory, waiting if necessary until enough is available.
|
|
<a href=#89 id=89 data-nosnippet>89</a> ///
|
|
<a href=#90 id=90 data-nosnippet>90</a> /// On success, merges the new memory into this guard.
|
|
<a href=#91 id=91 data-nosnippet>91</a> ///
|
|
<a href=#92 id=92 data-nosnippet>92</a> /// # Errors
|
|
<a href=#93 id=93 data-nosnippet>93</a> /// - Returns error if requested bytes would exceed the manager's total limit
|
|
<a href=#94 id=94 data-nosnippet>94</a> /// - Returns error if the semaphore is unexpectedly closed
|
|
<a href=#95 id=95 data-nosnippet>95</a> </span><span class="kw">pub async fn </span>acquire_additional(<span class="kw-2">&mut </span><span class="self">self</span>, bytes: u64) -> <span class="prelude-ty">Result</span><()> {
|
|
<a href=#96 id=96 data-nosnippet>96</a> <span class="kw">if </span>bytes == <span class="number">0 </span>{
|
|
<a href=#97 id=97 data-nosnippet>97</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(());
|
|
<a href=#98 id=98 data-nosnippet>98</a> }
|
|
<a href=#99 id=99 data-nosnippet>99</a>
|
|
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">match </span><span class="kw-2">&mut </span><span class="self">self</span>.state {
|
|
<a href=#101 id=101 data-nosnippet>101</a> GuardState::Released => {
|
|
<a href=#102 id=102 data-nosnippet>102</a> <span class="macro">debug_assert!</span>(<span class="bool-val">false</span>, <span class="string">"released memory guard state should not be reused"</span>);
|
|
<a href=#103 id=103 data-nosnippet>103</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#104 id=104 data-nosnippet>104</a> }
|
|
<a href=#105 id=105 data-nosnippet>105</a> GuardState::Unlimited {
|
|
<a href=#106 id=106 data-nosnippet>106</a> quota,
|
|
<a href=#107 id=107 data-nosnippet>107</a> granted_bytes,
|
|
<a href=#108 id=108 data-nosnippet>108</a> } => {
|
|
<a href=#109 id=109 data-nosnippet>109</a> quota.add_in_use(bytes);
|
|
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw-2">*</span>granted_bytes = granted_bytes.saturating_add(bytes);
|
|
<a href=#111 id=111 data-nosnippet>111</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#112 id=112 data-nosnippet>112</a> }
|
|
<a href=#113 id=113 data-nosnippet>113</a> GuardState::Limited { quota, permit } => {
|
|
<a href=#114 id=114 data-nosnippet>114</a> <span class="kw">let </span>additional_permits = quota.bytes_to_permits(bytes);
|
|
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">let </span>current_permits = permit.num_permits() <span class="kw">as </span>u32;
|
|
<a href=#116 id=116 data-nosnippet>116</a>
|
|
<a href=#117 id=117 data-nosnippet>117</a> <span class="macro">ensure!</span>(
|
|
<a href=#118 id=118 data-nosnippet>118</a> current_permits.saturating_add(additional_permits) <= quota.limit_permits,
|
|
<a href=#119 id=119 data-nosnippet>119</a> MemoryLimitExceededSnafu {
|
|
<a href=#120 id=120 data-nosnippet>120</a> requested_bytes: bytes,
|
|
<a href=#121 id=121 data-nosnippet>121</a> limit_bytes: quota.permits_to_bytes(quota.limit_permits)
|
|
<a href=#122 id=122 data-nosnippet>122</a> }
|
|
<a href=#123 id=123 data-nosnippet>123</a> );
|
|
<a href=#124 id=124 data-nosnippet>124</a>
|
|
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">let </span>additional_permit = quota
|
|
<a href=#126 id=126 data-nosnippet>126</a> .semaphore
|
|
<a href=#127 id=127 data-nosnippet>127</a> .clone()
|
|
<a href=#128 id=128 data-nosnippet>128</a> .acquire_many_owned(additional_permits)
|
|
<a href=#129 id=129 data-nosnippet>129</a> .<span class="kw">await
|
|
<a href=#130 id=130 data-nosnippet>130</a> </span>.map_err(|<span class="kw">_</span>| MemorySemaphoreClosedSnafu.build())<span class="question-mark">?</span>;
|
|
<a href=#131 id=131 data-nosnippet>131</a>
|
|
<a href=#132 id=132 data-nosnippet>132</a> permit.merge(additional_permit);
|
|
<a href=#133 id=133 data-nosnippet>133</a> quota.update_in_use_metric();
|
|
<a href=#134 id=134 data-nosnippet>134</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#135 id=135 data-nosnippet>135</a> }
|
|
<a href=#136 id=136 data-nosnippet>136</a> }
|
|
<a href=#137 id=137 data-nosnippet>137</a> }
|
|
<a href=#138 id=138 data-nosnippet>138</a>
|
|
<a href=#139 id=139 data-nosnippet>139</a> <span class="doccomment">/// Tries to acquire additional memory without waiting.
|
|
<a href=#140 id=140 data-nosnippet>140</a> ///
|
|
<a href=#141 id=141 data-nosnippet>141</a> /// On success, merges the new memory into this guard and returns true.
|
|
<a href=#142 id=142 data-nosnippet>142</a> /// On failure, returns false and leaves this guard unchanged.
|
|
<a href=#143 id=143 data-nosnippet>143</a> </span><span class="kw">pub fn </span>try_acquire_additional(<span class="kw-2">&mut </span><span class="self">self</span>, bytes: u64) -> bool {
|
|
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw">if </span>bytes == <span class="number">0 </span>{
|
|
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">return </span><span class="bool-val">true</span>;
|
|
<a href=#146 id=146 data-nosnippet>146</a> }
|
|
<a href=#147 id=147 data-nosnippet>147</a>
|
|
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw">match </span><span class="kw-2">&mut </span><span class="self">self</span>.state {
|
|
<a href=#149 id=149 data-nosnippet>149</a> GuardState::Released => {
|
|
<a href=#150 id=150 data-nosnippet>150</a> <span class="macro">debug_assert!</span>(<span class="bool-val">false</span>, <span class="string">"released memory guard state should not be reused"</span>);
|
|
<a href=#151 id=151 data-nosnippet>151</a> <span class="bool-val">false
|
|
<a href=#152 id=152 data-nosnippet>152</a> </span>}
|
|
<a href=#153 id=153 data-nosnippet>153</a> GuardState::Unlimited {
|
|
<a href=#154 id=154 data-nosnippet>154</a> quota,
|
|
<a href=#155 id=155 data-nosnippet>155</a> granted_bytes,
|
|
<a href=#156 id=156 data-nosnippet>156</a> } => {
|
|
<a href=#157 id=157 data-nosnippet>157</a> quota.add_in_use(bytes);
|
|
<a href=#158 id=158 data-nosnippet>158</a> <span class="kw-2">*</span>granted_bytes = granted_bytes.saturating_add(bytes);
|
|
<a href=#159 id=159 data-nosnippet>159</a> <span class="bool-val">true
|
|
<a href=#160 id=160 data-nosnippet>160</a> </span>}
|
|
<a href=#161 id=161 data-nosnippet>161</a> GuardState::Limited { quota, permit } => {
|
|
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">let </span>additional_permits = quota.bytes_to_permits(bytes);
|
|
<a href=#163 id=163 data-nosnippet>163</a>
|
|
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">match </span>quota
|
|
<a href=#165 id=165 data-nosnippet>165</a> .semaphore
|
|
<a href=#166 id=166 data-nosnippet>166</a> .clone()
|
|
<a href=#167 id=167 data-nosnippet>167</a> .try_acquire_many_owned(additional_permits)
|
|
<a href=#168 id=168 data-nosnippet>168</a> {
|
|
<a href=#169 id=169 data-nosnippet>169</a> <span class="prelude-val">Ok</span>(additional_permit) => {
|
|
<a href=#170 id=170 data-nosnippet>170</a> permit.merge(additional_permit);
|
|
<a href=#171 id=171 data-nosnippet>171</a> quota.update_in_use_metric();
|
|
<a href=#172 id=172 data-nosnippet>172</a> <span class="bool-val">true
|
|
<a href=#173 id=173 data-nosnippet>173</a> </span>}
|
|
<a href=#174 id=174 data-nosnippet>174</a> <span class="prelude-val">Err</span>(TryAcquireError::NoPermits) | <span class="prelude-val">Err</span>(TryAcquireError::Closed) => {
|
|
<a href=#175 id=175 data-nosnippet>175</a> quota.metrics.inc_exhausted(<span class="string">"try_acquire_additional"</span>);
|
|
<a href=#176 id=176 data-nosnippet>176</a> <span class="bool-val">false
|
|
<a href=#177 id=177 data-nosnippet>177</a> </span>}
|
|
<a href=#178 id=178 data-nosnippet>178</a> }
|
|
<a href=#179 id=179 data-nosnippet>179</a> }
|
|
<a href=#180 id=180 data-nosnippet>180</a> }
|
|
<a href=#181 id=181 data-nosnippet>181</a> }
|
|
<a href=#182 id=182 data-nosnippet>182</a>
|
|
<a href=#183 id=183 data-nosnippet>183</a> <span class="doccomment">/// Acquires additional memory based on the given policy.
|
|
<a href=#184 id=184 data-nosnippet>184</a> ///
|
|
<a href=#185 id=185 data-nosnippet>185</a> /// - For `OnExhaustedPolicy::Wait`: Waits up to the timeout duration for memory to become available
|
|
<a href=#186 id=186 data-nosnippet>186</a> /// - For `OnExhaustedPolicy::Fail`: Returns immediately if memory is not available
|
|
<a href=#187 id=187 data-nosnippet>187</a> ///
|
|
<a href=#188 id=188 data-nosnippet>188</a> /// # Errors
|
|
<a href=#189 id=189 data-nosnippet>189</a> /// - `MemoryLimitExceeded`: Requested bytes would exceed the total limit (both policies), or memory is currently exhausted (Fail policy only)
|
|
<a href=#190 id=190 data-nosnippet>190</a> /// - `MemoryAcquireTimeout`: Timeout elapsed while waiting for memory (Wait policy only)
|
|
<a href=#191 id=191 data-nosnippet>191</a> /// - `MemorySemaphoreClosed`: The internal semaphore is unexpectedly closed (rare, indicates system issue)
|
|
<a href=#192 id=192 data-nosnippet>192</a> </span><span class="kw">pub async fn </span>acquire_additional_with_policy(
|
|
<a href=#193 id=193 data-nosnippet>193</a> <span class="kw-2">&mut </span><span class="self">self</span>,
|
|
<a href=#194 id=194 data-nosnippet>194</a> bytes: u64,
|
|
<a href=#195 id=195 data-nosnippet>195</a> policy: OnExhaustedPolicy,
|
|
<a href=#196 id=196 data-nosnippet>196</a> ) -> <span class="prelude-ty">Result</span><()> {
|
|
<a href=#197 id=197 data-nosnippet>197</a> <span class="kw">match </span>policy {
|
|
<a href=#198 id=198 data-nosnippet>198</a> OnExhaustedPolicy::Wait { timeout } => {
|
|
<a href=#199 id=199 data-nosnippet>199</a> <span class="kw">match </span>tokio::time::timeout(timeout, <span class="self">self</span>.acquire_additional(bytes)).<span class="kw">await </span>{
|
|
<a href=#200 id=200 data-nosnippet>200</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Ok</span>(())) => <span class="prelude-val">Ok</span>(()),
|
|
<a href=#201 id=201 data-nosnippet>201</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Err</span>(e)) => <span class="prelude-val">Err</span>(e),
|
|
<a href=#202 id=202 data-nosnippet>202</a> <span class="prelude-val">Err</span>(_elapsed) => MemoryAcquireTimeoutSnafu {
|
|
<a href=#203 id=203 data-nosnippet>203</a> requested_bytes: bytes,
|
|
<a href=#204 id=204 data-nosnippet>204</a> waited: timeout,
|
|
<a href=#205 id=205 data-nosnippet>205</a> }
|
|
<a href=#206 id=206 data-nosnippet>206</a> .fail(),
|
|
<a href=#207 id=207 data-nosnippet>207</a> }
|
|
<a href=#208 id=208 data-nosnippet>208</a> }
|
|
<a href=#209 id=209 data-nosnippet>209</a> OnExhaustedPolicy::Fail => {
|
|
<a href=#210 id=210 data-nosnippet>210</a> <span class="kw">if </span><span class="self">self</span>.try_acquire_additional(bytes) {
|
|
<a href=#211 id=211 data-nosnippet>211</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#212 id=212 data-nosnippet>212</a> } <span class="kw">else </span>{
|
|
<a href=#213 id=213 data-nosnippet>213</a> MemoryLimitExceededSnafu {
|
|
<a href=#214 id=214 data-nosnippet>214</a> requested_bytes: bytes,
|
|
<a href=#215 id=215 data-nosnippet>215</a> limit_bytes: <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.state {
|
|
<a href=#216 id=216 data-nosnippet>216</a> GuardState::Released => <span class="number">0</span>,
|
|
<a href=#217 id=217 data-nosnippet>217</a> GuardState::Unlimited { .. } => <span class="number">0</span>, <span class="comment">// unreachable: unlimited mode always succeeds
|
|
<a href=#218 id=218 data-nosnippet>218</a> </span>GuardState::Limited { quota, .. } => {
|
|
<a href=#219 id=219 data-nosnippet>219</a> quota.permits_to_bytes(quota.limit_permits)
|
|
<a href=#220 id=220 data-nosnippet>220</a> }
|
|
<a href=#221 id=221 data-nosnippet>221</a> },
|
|
<a href=#222 id=222 data-nosnippet>222</a> }
|
|
<a href=#223 id=223 data-nosnippet>223</a> .fail()
|
|
<a href=#224 id=224 data-nosnippet>224</a> }
|
|
<a href=#225 id=225 data-nosnippet>225</a> }
|
|
<a href=#226 id=226 data-nosnippet>226</a> }
|
|
<a href=#227 id=227 data-nosnippet>227</a> }
|
|
<a href=#228 id=228 data-nosnippet>228</a>
|
|
<a href=#229 id=229 data-nosnippet>229</a> <span class="doccomment">/// Releases a portion of granted memory back to the pool before the guard is dropped.
|
|
<a href=#230 id=230 data-nosnippet>230</a> ///
|
|
<a href=#231 id=231 data-nosnippet>231</a> /// Returns true if the release succeeds or is a no-op; false if the request exceeds granted.
|
|
<a href=#232 id=232 data-nosnippet>232</a> </span><span class="kw">pub fn </span>release_partial(<span class="kw-2">&mut </span><span class="self">self</span>, bytes: u64) -> bool {
|
|
<a href=#233 id=233 data-nosnippet>233</a> <span class="kw">if </span>bytes == <span class="number">0 </span>{
|
|
<a href=#234 id=234 data-nosnippet>234</a> <span class="kw">return </span><span class="bool-val">true</span>;
|
|
<a href=#235 id=235 data-nosnippet>235</a> }
|
|
<a href=#236 id=236 data-nosnippet>236</a>
|
|
<a href=#237 id=237 data-nosnippet>237</a> <span class="kw">match </span><span class="kw-2">&mut </span><span class="self">self</span>.state {
|
|
<a href=#238 id=238 data-nosnippet>238</a> GuardState::Released => <span class="bool-val">true</span>,
|
|
<a href=#239 id=239 data-nosnippet>239</a> GuardState::Unlimited {
|
|
<a href=#240 id=240 data-nosnippet>240</a> quota,
|
|
<a href=#241 id=241 data-nosnippet>241</a> granted_bytes,
|
|
<a href=#242 id=242 data-nosnippet>242</a> } => {
|
|
<a href=#243 id=243 data-nosnippet>243</a> <span class="kw">if </span>bytes > <span class="kw-2">*</span>granted_bytes {
|
|
<a href=#244 id=244 data-nosnippet>244</a> <span class="kw">return </span><span class="bool-val">false</span>;
|
|
<a href=#245 id=245 data-nosnippet>245</a> }
|
|
<a href=#246 id=246 data-nosnippet>246</a>
|
|
<a href=#247 id=247 data-nosnippet>247</a> quota.sub_in_use(bytes);
|
|
<a href=#248 id=248 data-nosnippet>248</a> <span class="kw-2">*</span>granted_bytes = granted_bytes.saturating_sub(bytes);
|
|
<a href=#249 id=249 data-nosnippet>249</a> <span class="bool-val">true
|
|
<a href=#250 id=250 data-nosnippet>250</a> </span>}
|
|
<a href=#251 id=251 data-nosnippet>251</a> GuardState::Limited { quota, permit } => {
|
|
<a href=#252 id=252 data-nosnippet>252</a> <span class="kw">let </span>release_permits = quota.bytes_to_permits(bytes);
|
|
<a href=#253 id=253 data-nosnippet>253</a>
|
|
<a href=#254 id=254 data-nosnippet>254</a> <span class="kw">match </span>permit.split(release_permits <span class="kw">as </span>usize) {
|
|
<a href=#255 id=255 data-nosnippet>255</a> <span class="prelude-val">Some</span>(released_permit) => {
|
|
<a href=#256 id=256 data-nosnippet>256</a> quota.release_permit(released_permit);
|
|
<a href=#257 id=257 data-nosnippet>257</a> <span class="bool-val">true
|
|
<a href=#258 id=258 data-nosnippet>258</a> </span>}
|
|
<a href=#259 id=259 data-nosnippet>259</a> <span class="prelude-val">None </span>=> <span class="bool-val">false</span>,
|
|
<a href=#260 id=260 data-nosnippet>260</a> }
|
|
<a href=#261 id=261 data-nosnippet>261</a> }
|
|
<a href=#262 id=262 data-nosnippet>262</a> }
|
|
<a href=#263 id=263 data-nosnippet>263</a> }
|
|
<a href=#264 id=264 data-nosnippet>264</a>}
|
|
<a href=#265 id=265 data-nosnippet>265</a>
|
|
<a href=#266 id=266 data-nosnippet>266</a><span class="kw">impl</span><M: MemoryMetrics> Drop <span class="kw">for </span>MemoryGuard<M> {
|
|
<a href=#267 id=267 data-nosnippet>267</a> <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) {
|
|
<a href=#268 id=268 data-nosnippet>268</a> mem::replace(<span class="kw-2">&mut </span><span class="self">self</span>.state, GuardState::Released).release();
|
|
<a href=#269 id=269 data-nosnippet>269</a> }
|
|
<a href=#270 id=270 data-nosnippet>270</a>}
|
|
<a href=#271 id=271 data-nosnippet>271</a>
|
|
<a href=#272 id=272 data-nosnippet>272</a><span class="kw">impl</span><M: MemoryMetrics> fmt::Debug <span class="kw">for </span>MemoryGuard<M> {
|
|
<a href=#273 id=273 data-nosnippet>273</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
|
<a href=#274 id=274 data-nosnippet>274</a> f.debug_struct(<span class="string">"MemoryGuard"</span>)
|
|
<a href=#275 id=275 data-nosnippet>275</a> .field(<span class="string">"granted_bytes"</span>, <span class="kw-2">&</span><span class="self">self</span>.granted_bytes())
|
|
<a href=#276 id=276 data-nosnippet>276</a> .finish()
|
|
<a href=#277 id=277 data-nosnippet>277</a> }
|
|
<a href=#278 id=278 data-nosnippet>278</a>}
|
|
</code></pre></div></section></main></body></html> |