blob: 2e61e2c9b34d238bd2f5e97f7efe257461298f7f [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_types/src/metadata.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>metadata.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_types/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_types/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>
</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>::types::{Attributes, IsvExtProdId, IsvFamilyId, Measurement, MiscSelect};
<span class="comment">/* arch .h*/
</span><span class="kw">pub const </span>SE_PAGE_SHIFT: usize = <span class="number">12</span>;
<span class="kw">pub const </span>SE_PAGE_SIZE: usize = <span class="number">0x1000</span>;
<span class="kw">pub const </span>SE_KEY_SIZE: usize = <span class="number">384</span>;
<span class="kw">pub const </span>SE_EXPONENT_SIZE: usize = <span class="number">4</span>;
<span class="comment">/* version of metadata */
</span><span class="kw">pub const </span>MAJOR_VERSION: u32 = <span class="number">2</span>;
<span class="kw">pub const </span>MINOR_VERSION: u32 = <span class="number">4</span>;
<span class="kw">pub const </span>SGX_2_ELRANGE_MAJOR_VERSION: u32 = <span class="number">12</span>; <span class="comment">//MAJOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>SGX_1_ELRANGE_MAJOR_VERSION: u32 = <span class="number">11</span>; <span class="comment">//MINOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>SGX_2_1_MAJOR_VERSION: u32 = <span class="number">2</span>; <span class="comment">//MAJOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>SGX_2_1_MINOR_VERSION: u32 = <span class="number">2</span>; <span class="comment">//MINOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>SGX_2_0_MAJOR_VERSION: u32 = <span class="number">2</span>; <span class="comment">//MAJOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>SGX_2_0_MINOR_VERSION: u32 = <span class="number">1</span>; <span class="comment">//MINOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>SGX_1_9_MAJOR_VERSION: u32 = <span class="number">1</span>; <span class="comment">//MAJOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>SGX_1_9_MINOR_VERSION: u32 = <span class="number">4</span>; <span class="comment">//MINOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>SGX_1_5_MAJOR_VERSION: u32 = <span class="number">1</span>; <span class="comment">//MAJOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>SGX_1_5_MINOR_VERSION: u32 = <span class="number">3</span>; <span class="comment">//MINOR_VERSION should not larger than 0FFFFFFFF
</span><span class="kw">pub const </span>METADATA_MAGIC: u64 = <span class="number">0x86A8_0294_635D_0E4C</span>;
<span class="kw">pub const </span>METADATA_SIZE: usize = <span class="number">0x5000</span>;
<span class="kw">pub const </span>TCS_TEMPLATE_SIZE: usize = <span class="number">72</span>;
<span class="kw">pub const </span>TCS_POLICY_BIND: u32 = <span class="number">0x0000_0000</span>; <span class="comment">/* If set, the TCS is bound to the application thread */
</span><span class="kw">pub const </span>TCS_POLICY_UNBIND: u32 = <span class="number">0x0000_0001</span>;
<span class="kw">pub const </span>MAX_SAVE_BUF_SIZE: u32 = <span class="number">2632</span>;
<span class="kw">pub const </span>TCS_NUM_MIN: u32 = <span class="number">1</span>;
<span class="kw">pub const </span>SSA_NUM_MIN: u32 = <span class="number">2</span>;
<span class="kw">pub const </span>SSA_FRAME_SIZE_MIN: u32 = <span class="number">1</span>;
<span class="kw">pub const </span>SSA_FRAME_SIZE_MAX: u32 = <span class="number">2</span>;
<span class="kw">pub const </span>STACK_SIZE_MIN: u32 = <span class="number">0x0000_2000</span>; <span class="comment">/* 8 KB */
</span><span class="kw">pub const </span>STACK_SIZE_MAX: u32 = <span class="number">0x0004_0000</span>; <span class="comment">/* 256 KB */
</span><span class="kw">pub const </span>HEAP_SIZE_MIN: u32 = <span class="number">0x0000_1000</span>; <span class="comment">/* 4 KB */
</span><span class="kw">pub const </span>HEAP_SIZE_MAX: u32 = <span class="number">0x0100_0000</span>; <span class="comment">/* 16 MB */
</span><span class="kw">pub const </span>RSRV_SIZE_MIN: u32 = <span class="number">0x0000_0000</span>; <span class="comment">/* 0 KB */
</span><span class="kw">pub const </span>RSRV_SIZE_MAX: u32 = <span class="number">0x0000_0000</span>; <span class="comment">/* 0 KB */
</span><span class="kw">pub const </span>DEFAULT_MISC_SELECT: u32 = <span class="number">0</span>;
<span class="kw">pub const </span>DEFAULT_MISC_MASK: u32 = <span class="number">0xFFFF_FFFF</span>;
<span class="kw">pub const </span>ISVFAMILYID_MAX: u64 = <span class="number">0xFFFF_FFFF_FFFF_FFFF</span>;
<span class="kw">pub const </span>ISVEXTPRODID_MAX: u64 = <span class="number">0xFFFF_FFFF_FFFF_FFFF</span>;
<span class="attribute">#[macro_export]
</span><span class="macro">macro_rules! </span>meta_data_make_version {
(<span class="macro-nonterminal">$major</span>:ident, <span class="macro-nonterminal">$minor</span>:ident) =&gt; {
(<span class="macro-nonterminal">$major </span><span class="kw">as </span>u64) &lt;&lt; <span class="number">32 </span>| <span class="macro-nonterminal">$minor </span><span class="kw">as </span>u64
};
}
<span class="attribute">#[macro_export]
</span><span class="macro">macro_rules! </span>major_version_of_metadata {
(<span class="macro-nonterminal">$version</span>:ident) =&gt; {
(<span class="macro-nonterminal">$version </span><span class="kw">as </span>u64) &gt;&gt; <span class="number">32
</span>};
}
<span class="attribute">#[macro_export]
</span><span class="macro">macro_rules! </span>minor_version_of_metadata {
(<span class="macro-nonterminal">$version</span>:ident) =&gt; {
(<span class="macro-nonterminal">$version </span><span class="kw">as </span>u64) &amp; <span class="number">0x0000_0000_FFFF_FFFF
</span>};
}
<span class="comment">/* metadata.h */
</span><span class="attribute">#[derive(Clone, Copy, Debug)]
#[repr(C, packed)]
</span><span class="kw">pub struct </span>DataDir {
<span class="kw">pub </span>offset: u32,
<span class="kw">pub </span>size: u32,
}
<span class="macro">impl_enum! </span>{
<span class="attribute">#[repr(u32)]
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd)]
</span><span class="kw">pub enum </span>DirIndex {
DIR_PATCH = <span class="number">0</span>,
DIR_LAYOUT = <span class="number">1</span>,
DIR_NUM = <span class="number">2</span>,
}
}
<span class="attribute">#[derive(Clone, Copy, Debug)]
#[repr(C, packed)]
</span><span class="kw">pub struct </span>ElRangeConfig {
<span class="kw">pub </span>enclave_image_base: u64,
<span class="kw">pub </span>elrange_start_base: u64,
<span class="kw">pub </span>elrange_size: u64,
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;hyper&quot;</span>))]
</span><span class="kw">pub const </span>METADATA_DATA_BYTES: usize = <span class="number">18592</span>;
<span class="attribute">#[cfg(feature = <span class="string">&quot;hyper&quot;</span>)]
</span><span class="kw">pub const </span>METADATA_DATA_BYTES: usize = <span class="number">18584</span>;
<span class="attribute">#[derive(Clone, Copy, Debug)]
#[repr(C, packed)]
</span><span class="kw">pub struct </span>MetaData {
<span class="kw">pub </span>magic_num: u64,
<span class="kw">pub </span>version: u64,
<span class="kw">pub </span>size: u32,
<span class="kw">pub </span>tcs_policy: u32,
<span class="kw">pub </span>ssa_frame_size: u32,
<span class="kw">pub </span>max_save_buffer_size: u32,
<span class="kw">pub </span>desired_misc_select: MiscSelect,
<span class="kw">pub </span>tcs_min_pool: u32,
<span class="kw">pub </span>enclave_size: u64,
<span class="kw">pub </span>attributes: Attributes,
<span class="kw">pub </span>enclave_css: EnclaveCss,
<span class="kw">pub </span>dirs: [DataDir; DirIndex::DIR_NUM <span class="kw">as </span>usize],
<span class="attribute">#[cfg(feature = <span class="string">&quot;hyper&quot;</span>)]
</span><span class="kw">pub </span>msbuf_size: u64,
<span class="kw">pub </span>data: [u8; METADATA_DATA_BYTES],
}
<span class="comment">/* arch.h */
</span><span class="kw">pub const </span>CSS_HEADER_RESERVED_BYTES: usize = <span class="number">84</span>;
<span class="attribute">#[derive(Clone, Copy, Debug)]
#[repr(C, packed)]
</span><span class="kw">pub struct </span>CssHeader {
<span class="kw">pub </span>header: [u8; <span class="number">12</span>],
<span class="kw">pub </span>css_type: u32,
<span class="kw">pub </span>module_vendor: u32,
<span class="kw">pub </span>date: u32,
<span class="kw">pub </span>header2: [u8; <span class="number">16</span>],
<span class="kw">pub </span>hw_version: u32,
<span class="kw">pub </span>reserved: [u8; CSS_HEADER_RESERVED_BYTES],
}
<span class="attribute">#[derive(Clone, Copy, Debug)]
#[repr(C, packed)]
</span><span class="kw">pub struct </span>CssKey {
<span class="kw">pub </span>modulus: [u8; SE_KEY_SIZE],
<span class="kw">pub </span>exponent: [u8; SE_EXPONENT_SIZE],
<span class="kw">pub </span>signature: [u8; SE_KEY_SIZE],
}
<span class="attribute">#[derive(Clone, Copy, Debug)]
#[repr(C, packed)]
</span><span class="kw">pub struct </span>CssBody {
<span class="kw">pub </span>misc_select: MiscSelect,
<span class="kw">pub </span>misc_mask: u32,
<span class="kw">pub </span>reserved: [u8; <span class="number">4</span>],
<span class="kw">pub </span>isv_family_id: IsvFamilyId,
<span class="kw">pub </span>attributes: Attributes,
<span class="kw">pub </span>attribute_mask: Attributes,
<span class="kw">pub </span>enclave_hash: Measurement,
<span class="kw">pub </span>reserved2: [u8; <span class="number">16</span>],
<span class="kw">pub </span>isvext_prod_id: IsvExtProdId,
<span class="kw">pub </span>isv_prod_id: u16,
<span class="kw">pub </span>isv_svn: u16,
}
<span class="attribute">#[derive(Clone, Copy, Debug)]
#[repr(C, packed)]
</span><span class="kw">pub struct </span>CssBuffer {
<span class="kw">pub </span>reserved: [u8; <span class="number">12</span>],
<span class="kw">pub </span>q1: [u8; SE_KEY_SIZE],
<span class="kw">pub </span>q2: [u8; SE_KEY_SIZE],
}
<span class="attribute">#[derive(Clone, Copy, Debug)]
#[repr(C, packed)]
</span><span class="kw">pub struct </span>EnclaveCss {
<span class="kw">pub </span>header: CssHeader,
<span class="kw">pub </span>key: CssKey,
<span class="kw">pub </span>body: CssBody,
<span class="kw">pub </span>buffer: CssBuffer,
}
<span class="macro">impl_struct_default! </span>{
DataDir;
CssHeader;
CssKey;
CssBody;
CssBuffer;
MetaData;
}
<span class="macro">impl_struct_ContiguousMemory! </span>{
DataDir;
CssHeader;
CssKey;
CssBody;
CssBuffer;
MetaData;
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="sgx_types" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>