blob: a94e7b6719b4e3e04357fe63be9f8f2c33917f5a [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 `services/utils/service_app_utils/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="../../teaclave_service_app_utils/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="../../teaclave_service_app_utils/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>
</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>anyhow::{bail, Context, <span class="prelude-ty">Result</span>};
<span class="kw">use </span>std::path::Path;
<span class="kw">use </span>std::sync::atomic::{AtomicBool, Ordering};
<span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>std::thread;
<span class="kw">use </span>teaclave_binder::proto::{ECallCommand, StartServiceInput, StartServiceOutput};
<span class="kw">use </span>teaclave_binder::TeeBinder;
<span class="kw">use </span>teaclave_config::RuntimeConfig;
<span class="kw">use </span>teaclave_types::{TeeServiceError, TeeServiceResult};
<span class="kw">extern </span><span class="string">&quot;C&quot; </span>{
<span class="kw">fn </span>_exit(status: i32) -&gt; !;
}
<span class="kw">struct </span>TeaclaveServiceLauncher {
tee: TeeBinder,
config: RuntimeConfig,
}
<span class="kw">impl </span>TeaclaveServiceLauncher {
<span class="kw">pub fn </span>new&lt;P: AsRef&lt;Path&gt;&gt;(package_name: <span class="kw-2">&amp;</span>str, config_path: P) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>config = RuntimeConfig::from_toml(config_path.as_ref())
.context(<span class="string">&quot;Failed to load config file.&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>tee = TeeBinder::new(package_name).context(<span class="string">&quot;Failed to new the enclave.&quot;</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="self">Self </span>{ tee, config })
}
<span class="kw">pub fn </span>start(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;String&gt; {
<span class="kw">let </span>input = StartServiceInput::new(<span class="self">self</span>.config.clone());
<span class="kw">let </span>command = ECallCommand::StartService;
<span class="kw">match </span><span class="self">self
</span>.tee
.invoke::&lt;StartServiceInput, TeeServiceResult&lt;StartServiceOutput&gt;&gt;(command, input)
{
<span class="prelude-val">Err</span>(e) =&gt; <span class="macro">bail!</span>(<span class="string">&quot;TEE invocation error: {:?}&quot;</span>, e),
<span class="prelude-val">Ok</span>(<span class="prelude-val">Err</span>(TeeServiceError::EnclaveForceTermination)) =&gt; {
<span class="macro">log::info!</span>(<span class="string">&quot;Exit&quot;</span>);
<span class="kw">if </span><span class="macro">cfg!</span>(sgx_sim) {
<span class="comment">// use _exit to force exit in simulation mode to avoid SIGSEG
</span><span class="kw">unsafe </span>{
_exit(<span class="number">1</span>);
}
} <span class="kw">else </span>{
std::process::exit(<span class="number">1</span>);
}
}
<span class="prelude-val">Ok</span>(<span class="prelude-val">Err</span>(e)) =&gt; <span class="macro">bail!</span>(<span class="string">&quot;Service exit with error: {:?}&quot;</span>, e),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Ok</span>(String::from(<span class="string">&quot;Service successfully exit&quot;</span>)),
}
}
<span class="kw">pub fn </span>finalize(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.tee.finalize();
}
<span class="doccomment">/// # Safety
/// Force to destroy current enclave.
</span><span class="kw">pub unsafe fn </span>destroy(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.tee.destroy();
}
}
<span class="kw">pub fn </span>launch_teaclave_service(host_package_name: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
env_logger::init_from_env(
env_logger::Env::new()
.filter_or(<span class="string">&quot;TEACLAVE_LOG&quot;</span>, <span class="string">&quot;RUST_LOG&quot;</span>)
.write_style_or(<span class="string">&quot;TEACLAVE_LOG_STYLE&quot;</span>, <span class="string">&quot;RUST_LOG_STYLE&quot;</span>),
);
<span class="kw">let </span>launcher = Arc::new(TeaclaveServiceLauncher::new(
host_package_name,
<span class="string">&quot;runtime.config.toml&quot;</span>,
)<span class="question-mark">?</span>);
<span class="kw">let </span>launcher_ref = launcher.clone();
thread::spawn(<span class="kw">move </span>|| {
<span class="kw">let _ </span>= launcher_ref.start();
<span class="kw">unsafe </span>{ libc::raise(signal_hook::SIGTERM) }
});
<span class="kw">let </span>term = Arc::new(AtomicBool::new(<span class="bool-val">false</span>));
register_signals(term.clone()).context(<span class="string">&quot;Failed to register signal handler&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">while </span>!term.load(Ordering::Relaxed) {
thread::park();
}
launcher.finalize();
<span class="kw">unsafe </span>{
launcher.destroy(); <span class="comment">// force to destroy the enclave
</span>}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>register_signals(term: Arc&lt;AtomicBool&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">for </span>signal <span class="kw">in </span><span class="kw-2">&amp;</span>[
signal_hook::SIGTERM,
signal_hook::SIGINT,
signal_hook::SIGHUP,
] {
<span class="kw">let </span>term_ref = term.clone();
<span class="kw">let </span>thread = std::thread::current();
<span class="kw">unsafe </span>{
signal_hook::register(<span class="kw-2">*</span>signal, <span class="kw">move </span>|| {
term_ref.store(<span class="bool-val">true</span>, Ordering::Relaxed);
thread.unpark();
})<span class="question-mark">?</span>;
}
}
<span class="prelude-val">Ok</span>(())
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="teaclave_service_app_utils" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>