-
Notifications
You must be signed in to change notification settings - Fork 539
/
urts_com.h
378 lines (311 loc) · 12.6 KB
/
urts_com.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
/*
* Copyright (C) 2011-2016 Intel Corporation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef _URTS_COM_H_
#define _URTS_COM_H_
#include "arch.h"
#include "sgx_error.h"
#include "se_error_internal.h"
#include "se_trace.h"
#include "file.h"
#include "sgx_eid.h"
#include "se_map.h"
#include "launch_checker.h"
#include "debugger_support.h"
#include "loader.h"
#include "binparser.h"
#include "cpuid.h"
#include "se_macro.h"
#include "prd_css_util.h"
#include "se_detect.h"
#ifndef PARSER
#include "elfparser.h"
#define PARSER ElfParser
#endif
#include "ittnotify.h"
#include "ittnotify_config.h"
#include "ittnotify_types.h"
extern "C" int __itt_init_ittlib(const char*, __itt_group_id);
extern "C" __itt_global* __itt_get_ittapi_global();
#define HSW_C0 0x306c3
#define GPR_A0 0x406e0
#define GPR_B0 0x406e1
#define GPR_P0 0x506e0
#ifndef SE_SIM
static int validate_platform()
{
int cpu_info[4] = {0, 0, 0, 0};
__cpuid(cpu_info, 1);
// The compatibility between SDK and PSW is checked by the metadata version.
// Below check the compatibility between the platform and uRTS only.
// It is HSW users' responsibility to make the uRTS version to consistent with the HSW patch.
if(cpu_info[0] == HSW_C0)
{
return SGX_SUCCESS;
}
// GPR region
else if(cpu_info[0] == GPR_A0 || cpu_info[0] == GPR_B0 || cpu_info[0] == GPR_P0)
{
SE_TRACE(SE_TRACE_ERROR, "ERROR: The enclave cannot be launched on current platform.\n");
return SGX_ERROR_INVALID_VERSION;
}
return SGX_SUCCESS;
}
#endif
static sgx_status_t get_metadata(BinParser *parser, const int debug, metadata_t **metadata, sgx_misc_attribute_t *sgx_misc_attr)
{
assert(parser != NULL && metadata != NULL && sgx_misc_attr != NULL);
uint64_t meta_rva = parser->get_metadata_offset();
const uint8_t *base_addr = parser->get_start_addr();
uint64_t meta_block_size = parser->get_metadata_block_size();
uint64_t version = META_DATA_MAKE_VERSION(MAJOR_VERSION,MINOR_VERSION );
//scan multiple metadata list in sgx_metadata section
do{
*metadata = GET_PTR(metadata_t, base_addr, meta_rva);
if((*metadata)->magic_num != METADATA_MAGIC)
return SGX_ERROR_INVALID_METADATA;
//check metadata version
if(version == (*metadata)->version)
break;
if(0 == (*metadata)->size)
{
SE_TRACE(SE_TRACE_ERROR, "ERROR: metadata's size can't be zero.\n");
return SGX_ERROR_INVALID_METADATA;
}
meta_rva += (*metadata)->size; /*goto next metadata offset*/
if(meta_rva - (parser->get_metadata_offset()) >= meta_block_size)
{
SE_TRACE(SE_TRACE_ERROR, "ERROR: Exceed metadata block bound.\n");
return SGX_ERROR_INVALID_METADATA;
}
}while(1);
return (sgx_status_t)get_enclave_creator()->get_misc_attr(sgx_misc_attr, *metadata, NULL, debug);
}
static int __create_enclave(BinParser &parser, uint8_t* base_addr, const metadata_t *metadata, se_file_t& file, const bool debug, SGXLaunchToken *lc, le_prd_css_file_t *prd_css_file, sgx_enclave_id_t *enclave_id, sgx_misc_attribute_t *misc_attr)
{
// The "parser" will be registered into "loader" and "loader" will be registered into "enclave".
// After enclave is created, "parser" and "loader" are not needed any more.
debug_enclave_info_t *debug_info = NULL;
int ret = SGX_SUCCESS;
CLoader loader(base_addr, parser);
ret = loader.load_enclave_ex(lc, debug, metadata, prd_css_file, misc_attr);
if (ret != SGX_SUCCESS)
{
return ret;
}
CEnclave* enclave = new CEnclave(loader);
// initialize the enclave object
ret = enclave->initialize(file,
loader.get_enclave_id(),
const_cast<void*>(loader.get_start_addr()),
metadata->enclave_size,
metadata->tcs_policy);
if (ret != SGX_SUCCESS)
{
loader.destroy_enclave();
delete enclave; // The `enclave' object owns the `loader' object.
return ret;
}
std::vector<tcs_t *> tcs_list = loader.get_tcs_list();
for (unsigned idx = 0; idx < tcs_list.size(); ++idx)
{
enclave->add_thread(tcs_list[idx]);
SE_TRACE(SE_TRACE_DEBUG, "add tcs %p\n", tcs_list[idx]);
}
// It is accurate to get debug flag from secs
enclave->set_dbg_flag(!!(loader.get_secs().attributes.flags & SGX_FLAGS_DEBUG));
debug_info = const_cast<debug_enclave_info_t *>(enclave->get_debug_info());
enclave->set_extra_debug_info(const_cast<secs_t &>(loader.get_secs()));
//add enclave to enclave pool before init_enclave because in simualtion
//mode init_enclave will rely on CEnclavePool to get Enclave instance.
if (FALSE == CEnclavePool::instance()->add_enclave(enclave))
{
ret = SGX_ERROR_UNEXPECTED;
goto fail;
}
if(debug)
debug_info->enclave_type |= ET_DEBUG;
if (!(get_enclave_creator()->use_se_hw()))
debug_info->enclave_type |= ET_SIM;
bool isVTuneProfiling;
if(debug || !(get_enclave_creator()->use_se_hw()))
{
SE_TRACE(SE_TRACE_DEBUG, "Debug enclave. Checking if VTune is profiling\n");
__itt_init_ittlib(NULL, __itt_group_none);
if(__itt_get_ittapi_global()->api_initialized && __itt_get_ittapi_global()->lib)
isVTuneProfiling = true;
else
isVTuneProfiling = false;
if(isVTuneProfiling)
{
SE_TRACE(SE_TRACE_DEBUG, "VTune is profiling\n");
bool thread_updated;
thread_updated = enclave->update_debug_flag(1);
if(thread_updated == false)
{
SE_TRACE(SE_TRACE_DEBUG, "Failed to update debug OPTIN bit\n");
}
else
{
SE_TRACE(SE_TRACE_DEBUG, "Updated debug OPTIN bit\n");
}
uint64_t enclave_start_addr;
uint64_t enclave_end_addr;
const char* enclave_path;
enclave_start_addr = (uint64_t) loader.get_start_addr();
enclave_end_addr = enclave_start_addr + (uint64_t) metadata->enclave_size;
SE_TRACE(SE_TRACE_DEBUG, "Invoking VTune's module mapping API __itt_module_load \n");
SE_TRACE(SE_TRACE_DEBUG, "Enclave_start_addr==0x%llx\n", enclave_start_addr);
SE_TRACE(SE_TRACE_DEBUG, "Enclave_end_addr==0x%llx\n", enclave_end_addr);
enclave_path = (const char*)file.name;
SE_TRACE(SE_TRACE_DEBUG, "Enclave_path==%s\n", enclave_path);
__itt_module_load((void*)enclave_start_addr, (void*) enclave_end_addr, enclave_path);
}
else
{
SE_TRACE(SE_TRACE_DEBUG, "VTune is not profiling. Debug OPTIN bit not set and API to do module mapping not invoked\n");
}
}
//send debug event to debugger when enclave is debug mode or release mode
//set struct version
debug_info->struct_version = enclave->get_debug_info()->struct_version;
//generate load debug event after EINIT
generate_enclave_debug_event(URTS_EXCEPTION_POSTINITENCLAVE, debug_info);
//call trts to do some intialization
if(SGX_SUCCESS != (ret = get_enclave_creator()->initialize(loader.get_enclave_id())))
{
sgx_status_t status = SGX_SUCCESS;
CEnclavePool::instance()->remove_enclave(loader.get_enclave_id(), status);
goto fail;
}
if(SGX_SUCCESS != (ret = loader.set_memory_protection()))
{
sgx_status_t status = SGX_SUCCESS;
CEnclavePool::instance()->remove_enclave(loader.get_enclave_id(), status);
goto fail;
}
*enclave_id = loader.get_enclave_id();
return SGX_SUCCESS;
fail:
loader.destroy_enclave();
delete enclave;
return ret;
}
sgx_status_t _create_enclave(const bool debug, se_file_handle_t pfile, se_file_t& file, le_prd_css_file_t *prd_css_file, sgx_launch_token_t *launch, int *launch_updated, sgx_enclave_id_t *enclave_id, sgx_misc_attribute_t *misc_attr)
{
unsigned int ret = SGX_SUCCESS;
sgx_status_t lt_result = SGX_SUCCESS;
uint32_t file_size = 0;
map_handle_t* mh = NULL;
sgx_misc_attribute_t sgx_misc_attr;
metadata_t *metadata = NULL;
SGXLaunchToken *lc = NULL;
memset(&sgx_misc_attr, 0, sizeof(sgx_misc_attribute_t));
if(NULL == launch || NULL == launch_updated || NULL == enclave_id)
return SGX_ERROR_INVALID_PARAMETER;
#ifndef SE_SIM
ret = validate_platform();
if(ret != SGX_SUCCESS)
return (sgx_status_t)ret;
#endif
mh = map_file(pfile, &file_size);
if (!mh)
return SGX_ERROR_OUT_OF_MEMORY;
PARSER parser(const_cast<uint8_t *>(mh->base_addr), (uint64_t)(file_size));
if(SGX_SUCCESS != (ret = parser.run_parser()))
{
goto clean_return;
}
//Make sure HW uRTS won't load simulation enclave and vice verse.
if(get_enclave_creator()->use_se_hw() != (!parser.get_symbol_rva("g_global_data_sim")))
{
SE_TRACE_WARNING("HW and Simulation mode incompatibility detected. The enclave is linked with the incorrect tRTS library.\n");
ret = SGX_ERROR_MODE_INCOMPATIBLE;
goto clean_return;
}
if(SGX_SUCCESS != (ret = get_metadata(&parser, debug, &metadata, &sgx_misc_attr)))
{
goto clean_return;
}
*launch_updated = FALSE;
lc = new SGXLaunchToken(&metadata->enclave_css, &sgx_misc_attr.secs_attr, launch);
lt_result = lc->update_launch_token(false);
if(SGX_SUCCESS != lt_result)
{
ret = lt_result;
goto clean_return;
}
#ifndef SE_SIM
// Only LE allows the prd_css_file
if(is_le(lc, &metadata->enclave_css) == false && prd_css_file != NULL)
{
ret = SGX_ERROR_INVALID_PARAMETER;
goto clean_return;
}
#endif
//Need to set the whole misc_attr instead of just secs_attr.
do {
ret = __create_enclave(parser, mh->base_addr, metadata, file, debug, lc, prd_css_file, enclave_id,
misc_attr);
//SGX_ERROR_ENCLAVE_LOST caused by initializing enclave while power transition occurs
} while(SGX_ERROR_ENCLAVE_LOST == ret);
if(SE_ERROR_INVALID_LAUNCH_TOKEN == ret || SGX_ERROR_INVALID_CPUSVN == ret)
ret = SGX_ERROR_UNEXPECTED;
// The launch token is updated, so the SE_INVALID_MEASUREMENT is only caused by signature.
if(SE_ERROR_INVALID_MEASUREMENT == ret)
ret = SGX_ERROR_INVALID_SIGNATURE;
// The launch token is updated, so the SE_ERROR_INVALID_ISVSVNLE means user needs to update the LE image
if (SE_ERROR_INVALID_ISVSVNLE == ret)
ret = SGX_ERROR_UPDATE_NEEDED;
if(SGX_SUCCESS != ret)
goto clean_return;
else if(lc->is_launch_updated())
{
*launch_updated = TRUE;
ret = lc->get_launch_token(launch);
}
clean_return:
if(mh != NULL)
unmap_file(mh);
if(lc != NULL)
delete lc;
return (sgx_status_t)ret;
}
extern "C" sgx_status_t sgx_destroy_enclave(const sgx_enclave_id_t enclave_id)
{
sgx_status_t status = SGX_SUCCESS;
CEnclave* enclave = CEnclavePool::instance()->remove_enclave(enclave_id, status);
if (enclave)
{
delete enclave;
}
return status;
}
#endif