blob: 7ca830d13ceef4aaff940ca6035c0d4a14e90230 [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/sunhe/incubator-teaclave/third_party/rust-sgx-sdk/sgx_protected_fs/tfs/src/sys/file/flush.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>flush.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="../../../../sgx_tprotected_fs/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="../../../../sgx_tprotected_fs/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>
</pre><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// &quot;License&quot;); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License..
</span><span class="kw">use </span><span class="kw">crate</span>::sys::error::FsResult;
<span class="kw">use </span><span class="kw">crate</span>::sys::file::{FileInner, FileStatus};
<span class="kw">use </span><span class="kw">crate</span>::sys::host::{<span class="self">self</span>, HostFs, RecoveryFile};
<span class="kw">use </span><span class="kw">crate</span>::sys::metadata::MD_USER_DATA_SIZE;
<span class="kw">use </span><span class="kw">crate</span>::sys::node::FileNodeRef;
<span class="kw">use </span>sgx_types::error::SgxStatus;
<span class="kw">use </span>std::vec::Vec;
<span class="kw">impl </span>FileInner {
<span class="kw">pub fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; FsResult {
<span class="macro">ensure!</span>(<span class="self">self</span>.status.is_ok(), <span class="macro">esgx!</span>(SgxStatus::BadStatus));
<span class="kw">let </span>result = <span class="self">self</span>.internal_flush(<span class="bool-val">true</span>);
<span class="kw">if </span>result.is_err() &amp;&amp; <span class="self">self</span>.status.is_ok() {
<span class="self">self</span>.set_file_status(FileStatus::FlushError);
}
result
}
<span class="kw">pub fn </span>internal_flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, flush: bool) -&gt; FsResult {
<span class="kw">if </span>!<span class="self">self</span>.need_writing {
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
<span class="kw">if </span><span class="self">self</span>.is_need_write_node() {
<span class="self">self</span>.write_recovery_file().map_err(|error| {
<span class="self">self</span>.set_file_status(FileStatus::FlushError);
error
})<span class="question-mark">?</span>;
<span class="self">self</span>.set_update_flag(flush).map_err(|error| {
<span class="self">self</span>.set_file_status(FileStatus::FlushError);
error
})<span class="question-mark">?</span>;
<span class="self">self</span>.update_nodes().map_err(|error| {
<span class="self">self</span>.clear_update_flag();
<span class="self">self</span>.set_file_status(FileStatus::FlushError);
error
})<span class="question-mark">?</span>;
}
<span class="self">self</span>.update_metadata().map_err(|error| {
<span class="self">self</span>.clear_update_flag();
<span class="self">self</span>.set_file_status(FileStatus::CryptoError);
error
})<span class="question-mark">?</span>;
<span class="self">self</span>.write_to_disk(flush).map_err(|error| {
<span class="self">self</span>.set_file_status(FileStatus::WriteToDiskFailed);
error
})<span class="question-mark">?</span>;
<span class="self">self</span>.need_writing = <span class="bool-val">false</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub fn </span>write_to_disk(<span class="kw-2">&amp;mut </span><span class="self">self</span>, flush: bool) -&gt; FsResult {
<span class="kw">if </span><span class="self">self</span>.is_need_write_node() {
<span class="kw">for </span><span class="kw-2">mut </span>node <span class="kw">in </span><span class="self">self</span>.cache.iter().filter_map(|node| {
<span class="kw">let </span>node = node.borrow_mut();
<span class="kw">if </span>node.need_writing {
<span class="prelude-val">Some</span>(node)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}) {
node.write_to_disk(<span class="kw-2">&amp;mut </span><span class="self">self</span>.host_file)<span class="question-mark">?</span>;
}
<span class="self">self</span>.root_mht
.borrow_mut()
.write_to_disk(<span class="kw-2">&amp;mut </span><span class="self">self</span>.host_file)<span class="question-mark">?</span>;
}
<span class="self">self</span>.metadata.write_to_disk(<span class="kw-2">&amp;mut </span><span class="self">self</span>.host_file)<span class="question-mark">?</span>;
<span class="kw">if </span>flush {
<span class="self">self</span>.host_file.flush()<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>update_nodes(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; FsResult {
<span class="comment">// 1. encrypt the changed data
// 2. set the KEY+GMAC in the parent MHT
// 3. set the need_writing flag for all the parents
</span><span class="kw">for </span><span class="kw-2">mut </span>data_node <span class="kw">in </span><span class="self">self</span>.cache.iter().filter_map(|node| {
<span class="kw">let </span>node = node.borrow_mut();
<span class="kw">if </span>node.is_data() &amp;&amp; node.need_writing {
<span class="prelude-val">Some</span>(node)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}) {
<span class="kw">let </span>key = data_node.derive_key(<span class="kw-2">&amp;mut </span><span class="self">self</span>.key_gen)<span class="question-mark">?</span>;
data_node.encrypt(<span class="kw-2">&amp;</span>key)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>parent = data_node.parent.clone();
<span class="kw">while let </span><span class="prelude-val">Some</span>(mht) = parent {
<span class="kw">let </span><span class="kw-2">mut </span>mht = mht.borrow_mut();
<span class="kw">if </span>!mht.is_root_mht() {
mht.need_writing = <span class="bool-val">true</span>;
parent = mht.parent.clone();
} <span class="kw">else </span>{
<span class="kw">break</span>;
}
}
}
<span class="comment">// add all the mht nodes that needs writing to a list
</span><span class="kw">let </span><span class="kw-2">mut </span>mht_nodes = <span class="self">self
</span>.cache
.iter()
.filter_map(|node| {
<span class="kw">let </span>borrow = node.borrow();
<span class="kw">if </span>borrow.is_mht() &amp;&amp; borrow.need_writing {
<span class="prelude-val">Some</span>(node.clone())
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
})
.collect::&lt;Vec&lt;FileNodeRef&gt;&gt;();
<span class="comment">// sort the list from the last node to the first (bottom layers first)
</span>mht_nodes.sort_by(|a, b| b.borrow().cmp(<span class="kw-2">&amp;</span>a.borrow()));
<span class="kw">for </span><span class="kw-2">mut </span>mht_node <span class="kw">in </span>mht_nodes.iter().map(|node| node.borrow_mut()) {
<span class="kw">let </span>key = mht_node.derive_key(<span class="kw-2">&amp;mut </span><span class="self">self</span>.key_gen)<span class="question-mark">?</span>;
mht_node.encrypt(<span class="kw-2">&amp;</span>key)<span class="question-mark">?</span>;
}
<span class="comment">// update mht root gmac in the meta data node
</span><span class="kw">let </span><span class="kw-2">mut </span>root_mht = <span class="self">self</span>.root_mht.borrow_mut();
<span class="kw">let </span>key = root_mht.derive_key(<span class="kw-2">&amp;mut </span><span class="self">self</span>.key_gen)<span class="question-mark">?</span>;
<span class="kw">let </span>mac = root_mht.encrypt(<span class="kw-2">&amp;</span>key)<span class="question-mark">?</span>;
<span class="self">self</span>.metadata.encrypted_plain.mht_key = key;
<span class="self">self</span>.metadata.encrypted_plain.mht_gmac = mac;
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>update_metadata(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; FsResult {
<span class="kw">let </span>key = <span class="self">self</span>.metadata.derive_key(<span class="kw-2">&amp;mut </span><span class="self">self</span>.key_gen)<span class="question-mark">?</span>;
<span class="self">self</span>.metadata.encrypt(<span class="kw-2">&amp;</span>key)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>is_need_write_node(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.metadata.encrypted_plain.size &gt; MD_USER_DATA_SIZE
&amp;&amp; <span class="self">self</span>.root_mht.borrow().need_writing
}
<span class="kw">fn </span>set_update_flag(<span class="kw-2">&amp;mut </span><span class="self">self</span>, flush: bool) -&gt; FsResult {
<span class="self">self</span>.metadata.set_update_flag(<span class="number">1</span>);
<span class="kw">let </span>result = <span class="self">self</span>.metadata.write_to_disk(<span class="kw-2">&amp;mut </span><span class="self">self</span>.host_file);
<span class="self">self</span>.metadata.set_update_flag(<span class="number">0</span>);
result<span class="question-mark">?</span>;
<span class="kw">if </span>flush {
<span class="self">self</span>.host_file.flush().map_err(|error| {
<span class="kw">let _ </span>= <span class="self">self</span>.metadata.write_to_disk(<span class="kw-2">&amp;mut </span><span class="self">self</span>.host_file);
error
})<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>clear_update_flag(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="macro">assert!</span>(!<span class="self">self</span>.metadata.update_flag());
<span class="kw">let _ </span>= <span class="self">self</span>.metadata.write_to_disk(<span class="kw-2">&amp;mut </span><span class="self">self</span>.host_file);
<span class="kw">let _ </span>= <span class="self">self</span>.host_file.flush();
}
<span class="kw">fn </span>write_recovery_file_node(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; FsResult {
<span class="kw">let </span><span class="kw-2">mut </span>file = RecoveryFile::open(<span class="kw-2">&amp;</span><span class="self">self</span>.recovery_path)<span class="question-mark">?</span>;
<span class="kw">for </span>node <span class="kw">in </span><span class="self">self</span>.cache.iter().filter_map(|node| {
<span class="kw">let </span>node = node.borrow();
<span class="kw">if </span>node.need_writing &amp;&amp; !node.new_node {
<span class="prelude-val">Some</span>(node)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}) {
node.write_recovery_file(<span class="kw-2">&amp;mut </span>file)<span class="question-mark">?</span>;
}
<span class="kw">let </span>root_mht = <span class="self">self</span>.root_mht.borrow();
<span class="kw">if </span>root_mht.need_writing &amp;&amp; !root_mht.new_node {
root_mht.write_recovery_file(<span class="kw-2">&amp;mut </span>file)<span class="question-mark">?</span>;
}
<span class="self">self</span>.metadata.write_recovery_file(<span class="kw-2">&amp;mut </span>file)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>write_recovery_file(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; FsResult {
<span class="self">self</span>.write_recovery_file_node().map_err(|error| {
<span class="kw">let _ </span>= host::remove(<span class="kw-2">&amp;</span><span class="self">self</span>.recovery_path);
error
})
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="sgx_tprotected_fs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>