| <!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/time.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>time.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.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"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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"><div class="sidebar-menu" role="button">☰</div><a href='../../optee_utee/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><pre class="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> |
| </pre><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="comment">// or more contributor license agreements. See the NOTICE file</span> |
| <span class="comment">// distributed with this work for additional information</span> |
| <span class="comment">// regarding copyright ownership. The ASF licenses this file</span> |
| <span class="comment">// to you under the Apache License, Version 2.0 (the</span> |
| <span class="comment">// "License"); you may not use this file except in compliance</span> |
| <span class="comment">// with the License. You may obtain a copy of the License at</span> |
| <span class="comment">//</span> |
| <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="comment">//</span> |
| <span class="comment">// Unless required by applicable law or agreed to in writing,</span> |
| <span class="comment">// software distributed under the License is distributed on an</span> |
| <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="comment">// KIND, either express or implied. See the License for the</span> |
| <span class="comment">// specific language governing permissions and limitations</span> |
| <span class="comment">// under the License.</span> |
| |
| <span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">Error</span>, <span class="prelude-ty">Result</span>}; |
| <span class="kw">use</span> <span class="ident">optee_utee_sys</span> <span class="kw">as</span> <span class="ident">raw</span>; |
| <span class="kw">use</span> <span class="ident">std::fmt</span>; |
| |
| <span class="doccomment">/// A millisecond resolution structure for saving the time.</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Time</span> { |
| <span class="doccomment">/// The field for the seconds.</span> |
| <span class="kw">pub</span> <span class="ident">seconds</span>: <span class="ident">u32</span>, |
| <span class="doccomment">/// The field for the milliseconds within this second.</span> |
| <span class="kw">pub</span> <span class="ident">millis</span>: <span class="ident">u32</span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Time</span> { |
| <span class="doccomment">/// Create a new empty time structure.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { |
| <span class="ident">Time</span> { |
| <span class="ident">seconds</span>: <span class="number">0</span>, |
| <span class="ident">millis</span>: <span class="number">0</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Retrieve the current system time.</span> |
| <span class="doccomment">/// The origin of this system time is arbitrary and implementation-dependent.</span> |
| <span class="doccomment">/// Different TA instances may even have different system times.</span> |
| <span class="doccomment">/// The only guarantee is that the system time is not reset or rolled back during the life of a</span> |
| <span class="doccomment">/// given TA instance, so it can be used to compute time differences and operation deadlines.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Example</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// ```no_run</span> |
| <span class="doccomment">/// let mut time = Time::new();</span> |
| <span class="doccomment">/// time.system_time()?;</span> |
| <span class="doccomment">/// ```</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1) If the Implementation detects any error.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">system_time</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { |
| <span class="kw">unsafe</span> { |
| <span class="ident">raw::TEE_GetSystemTime</span>(<span class="self">self</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="kw">_</span> <span class="kw">as</span> <span class="kw">_</span>); |
| } |
| } |
| |
| <span class="doccomment">/// Wait for the specified number of milliseconds or wait forever if timeout equals</span> |
| <span class="doccomment">/// `raw::TEE_TIMEOUT_INFINITE` (0xFFFFFFFF). The waiting timer is `System Time`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Parameters</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1) `timeout`: The number of milliseconds to wait, or `raw::TEE_TIMEOUT_INFINITE`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Example</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// ```no_run</span> |
| <span class="doccomment">/// Time::wait(1000)?;</span> |
| <span class="doccomment">/// ```</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Errors</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1) `Cancel`: If the wait has been cancelled.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1) If the Implementation detects any error.</span> |
| |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">wait</span>(<span class="ident">timeout</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="kw">match</span> <span class="kw">unsafe</span> { <span class="ident">raw::TEE_Wait</span>(<span class="ident">timeout</span>) } { |
| <span class="ident">raw::TEE_SUCCESS</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(()), |
| <span class="ident">code</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error::from_raw_error</span>(<span class="ident">code</span>)), |
| } |
| } |
| |
| <span class="doccomment">/// Retrieve the persisten time of the Trusted Application. Since the timer is not</span> |
| <span class="doccomment">/// automatically set, this function should be called after [set_ta_time](Time::set_ta_time).</span> |
| <span class="doccomment">/// The time is a real-time source of time and the origin of this time is set individually by each Trusted Application.</span> |
| <span class="doccomment">/// Also, the time SHALL persist across reboots.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Example</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// ```no_run</span> |
| <span class="doccomment">/// let mut time = Time()?;</span> |
| <span class="doccomment">/// time.system_time()?;</span> |
| <span class="doccomment">/// time.set_ta_time()?;</span> |
| <span class="doccomment">/// time.ta_time()?;</span> |
| <span class="doccomment">/// ```</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Errors</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1) `TimeNotSet`: Time is not set.</span> |
| <span class="doccomment">/// 2) `TimeNeedsReset`: Time needs to be reset.</span> |
| <span class="doccomment">/// 3) `Overflow`: The number of seconds in the TA Persistent Time overflows the range of a</span> |
| <span class="doccomment">/// `u32`. The field `seconds` is still set to the TA Persistent Time truncated to 32 bits.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1) If the Implementation detects any error.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ta_time</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="kw">match</span> <span class="kw">unsafe</span> { <span class="ident">raw::TEE_GetTAPersistentTime</span>(<span class="self">self</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="kw">_</span> <span class="kw">as</span> <span class="kw">_</span>) } { |
| <span class="ident">raw::TEE_SUCCESS</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(()), |
| <span class="ident">code</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error::from_raw_error</span>(<span class="ident">code</span>)), |
| } |
| } |
| |
| <span class="doccomment">/// Set the persistent time of the current Trusted Application.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Errors</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1) `OutOfMemory`: If not enough memory is available to complete the operation.</span> |
| <span class="doccomment">/// 2) `SotrageNoSpace`: If insufficient storage space is available to complete the operation.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1) If the Implementation detects any error.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_ta_time</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="kw">match</span> <span class="kw">unsafe</span> { <span class="ident">raw::TEE_SetTAPersistentTime</span>(<span class="self">self</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="kw">_</span> <span class="kw">as</span> <span class="kw">_</span>) } { |
| <span class="ident">raw::TEE_SUCCESS</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(()), |
| <span class="ident">code</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error::from_raw_error</span>(<span class="ident">code</span>)), |
| } |
| } |
| |
| <span class="doccomment">/// Retrieve the current REE system time.</span> |
| <span class="doccomment">/// The time is as trusted as the REE itself and may also be tampered by the user.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1) If the Implementation detects any error.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ree_time</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { |
| <span class="kw">unsafe</span> { |
| <span class="ident">raw::TEE_GetREETime</span>(<span class="self">self</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="kw">_</span> <span class="kw">as</span> <span class="kw">_</span>); |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">Time</span> { |
| <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt::Formatter</span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt::Result</span> { |
| <span class="macro">write!</span>( |
| <span class="ident">f</span>, |
| <span class="string">"(second: {}, millisecond: {})"</span>, |
| <span class="self">self</span>.<span class="ident">seconds</span>, <span class="self">self</span>.<span class="ident">millis</span> |
| ) |
| } |
| } |
| </code></pre></div> |
| </section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="optee_utee" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div> |
| <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script> |
| </body></html> |
