| <!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 `binder/src/macros.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>macros.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_binder/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_binder/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> |
| </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 |
| // "License"); 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 |
| // "AS IS" 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="attribute">#[cfg(feature = <span class="string">"mesalock_sgx"</span>)] |
| #[macro_export] |
| </span><span class="macro">macro_rules! </span>register_ecall_handler { |
| ( <span class="kw">type </span><span class="macro-nonterminal">$cmd_type</span>: ty, $( (<span class="macro-nonterminal">$cmd</span>: path, <span class="macro-nonterminal">$arg</span>: ty, <span class="macro-nonterminal">$ret</span>: ty), )* ) => |
| { |
| <span class="kw">fn </span>ecall_ipc_lib_dispatcher(cmd: u32, input: <span class="kw-2">&</span>[u8]) -> anyhow::Result<Vec<u8>> { |
| <span class="kw">let </span>cmd = <<span class="macro-nonterminal">$cmd_type</span>>::from(cmd); |
| <span class="kw">match </span>cmd { |
| $( |
| <span class="macro-nonterminal">$cmd </span>=> dispatch_helper::<<span class="macro-nonterminal">$arg</span>, <span class="macro-nonterminal">$ret</span>>(input), |
| )* |
| <span class="kw">_ </span>=> <span class="macro">anyhow::bail!</span>(<span class="string">"ECallCommandNotRegistered"</span>), |
| } |
| } |
| <span class="kw">use </span>teaclave_binder::ipc::IpcReceiver; |
| |
| <span class="comment">// Declear a local trait, the [handle_ecall] attribute macro |
| // will help implement this trait and call user defined function. |
| </span><span class="kw">trait </span>HandleRequest<V> { |
| <span class="kw">fn </span>handle(<span class="kw-2">&</span><span class="self">self</span>) -> teaclave_types::TeeServiceResult<V>; |
| } |
| |
| <span class="kw">struct </span>ServeInstance<U, V> |
| <span class="kw">where |
| </span>U: HandleRequest<V> + <span class="kw">for</span><<span class="lifetime">'de</span>> serde::Deserialize<<span class="lifetime">'de</span>>, |
| V: serde::Serialize, |
| { |
| u: std::marker::PhantomData<U>, |
| v: std::marker::PhantomData<V>, |
| } |
| |
| <span class="kw">impl</span><U, V> ServeInstance<U, V> |
| <span class="kw">where |
| </span>U: HandleRequest<V> + <span class="kw">for</span><<span class="lifetime">'de</span>> serde::Deserialize<<span class="lifetime">'de</span>>, |
| V: serde::Serialize, |
| { |
| <span class="kw">fn </span>new() -> ServeInstance<U, V> { |
| ServeInstance { |
| u: std::marker::PhantomData, |
| v: std::marker::PhantomData, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><U, V> teaclave_binder::ipc::IpcService<U, V> <span class="kw">for </span>ServeInstance<U, V> |
| <span class="kw">where |
| </span>U: HandleRequest<V> + <span class="kw">for</span><<span class="lifetime">'de</span>> serde::Deserialize<<span class="lifetime">'de</span>>, |
| V: serde::Serialize, |
| { |
| <span class="kw">fn </span>handle_invoke(<span class="kw-2">&</span><span class="self">self</span>, input: U) -> teaclave_types::TeeServiceResult<V> { |
| <span class="macro">log::debug!</span>(<span class="string">"handle_invoke"</span>); |
| input.handle() |
| } |
| } |
| |
| <span class="kw">fn </span>dispatch_helper<U, V>(input: <span class="kw-2">&</span>[u8]) -> anyhow::Result<Vec<u8>> |
| <span class="kw">where |
| </span>U: HandleRequest<V> + <span class="kw">for</span><<span class="lifetime">'de</span>> serde::Deserialize<<span class="lifetime">'de</span>>, |
| V: serde::Serialize, |
| { |
| <span class="kw">let </span>instance = ServeInstance::<U, V>::new(); |
| teaclave_binder::ipc::ECallReceiver::dispatch(input, instance) |
| } |
| |
| <span class="doccomment">/// The actual ecall function defined in .edl. |
| </span><span class="attribute">#[cfg(not(feature=<span class="string">"enclave_unit_test"</span>))] |
| #[allow(clippy::not_unsafe_ptr_arg_deref)] |
| #[no_mangle] |
| </span><span class="kw">pub extern </span><span class="string">"C" </span><span class="kw">fn </span>ecall_ipc_entry_point( |
| cmd: u32, |
| in_buf: <span class="kw-2">*const </span>u8, |
| in_len: usize, |
| out_buf: <span class="kw-2">*mut </span>u8, |
| out_max: usize, |
| out_len: <span class="kw-2">&mut </span>usize, |
| ) -> teaclave_types::ECallStatus { |
| <span class="kw">if </span>in_buf.is_null() || out_buf.is_null() { |
| <span class="macro">log::error!</span>(<span class="string">"tee execute cmd: {:x}, invalid in/out buf."</span>, cmd); |
| <span class="kw">return </span>teaclave_types::ECallStatus(teaclave_types::ES_ERR_INVALID_PARAMETER); |
| } |
| |
| <span class="comment">// The last argument could be either * mut usize, or &mut usize |
| </span><span class="kw">let </span>input_buf: <span class="kw-2">&</span>[u8] = <span class="kw">unsafe </span>{ std::slice::from_raw_parts(in_buf, in_len) }; |
| |
| <span class="macro">log::trace!</span>(<span class="string">"tee receive cmd: {:x}, input_buf = {:?}"</span>, cmd, input_buf); |
| |
| <span class="kw">let </span>inner_vec = <span class="kw">unsafe </span>{ |
| <span class="kw">match </span>ecall_ipc_lib_dispatcher(cmd, input_buf) { |
| <span class="prelude-val">Ok</span>(out) => out, |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="macro">log::error!</span>(<span class="string">"tee execute cmd: {:x}, error: {}"</span>, cmd, e); |
| <span class="kw">return </span>teaclave_types::ECallStatus(teaclave_types::ES_ERR_GENERAL); |
| } |
| } |
| }; |
| |
| <span class="kw">let </span>inner_len = inner_vec.len(); |
| |
| <span class="comment">// ATTN: We should always set the out_len, no matter whether it is within the buffer range. |
| </span><span class="kw-2">*</span>out_len = inner_len; |
| |
| <span class="kw">if </span>inner_len > out_max { |
| <span class="macro">log::debug!</span>(<span class="string">"tee before copy out_buf check: out_max={:x} < inner={:x}"</span>, out_max, inner_len); |
| <span class="kw">return </span>teaclave_types::ECallStatus(teaclave_types::ES_ERR_FFI_INSUFFICIENT_OUTBUF_SIZE); |
| } |
| |
| <span class="comment">// The following lines use a trick of "constructing a mutable slice |
| // in place" using slice::from_raw_parts_mut You can always use |
| // ptr::copy_nonoverlapping to copy a buffer to the output pointer |
| // (see the above crypto sample) |
| </span><span class="kw">unsafe </span>{ |
| std::ptr::copy_nonoverlapping(inner_vec.as_ptr(), out_buf, inner_len); |
| } |
| |
| <span class="comment">// out_len would be used in `set_len` in the untrusted app |
| // so out_len cannot be larger than out_max. Additional checks are **required**. |
| </span>teaclave_types::ECallStatus::default() |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="teaclave_binder" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
