Skip to content

Commit

Permalink
selftests/sgx: Migrate to kselftest harness
Browse files Browse the repository at this point in the history 
Migrate to kselftest harness. Use a fixture test with enclave initialized
and de-initialized for each of the existing three tests, in other words:

1. One FIXTURE() for managing the enclave life-cycle.
2. Three TEST_F()'s, one for each test case.

Dump lines of /proc/self/maps matching "sgx" in FIXTURE_SETUP() as this
can be very useful debugging information later on.

Amended commit log:
This migration changes the output of this test. Instead of skipping
the tests if open /dev/sgx_enclave fails, it will run all the tests
and report failures on all of them.
Shuah Khan <[email protected]>

Signed-off-by: Jarkko Sakkinen <[email protected]>
Signed-off-by: Shuah Khan <[email protected]>
  • Loading branch information
@jarkkojs @shuahkh
jarkkojs authored and shuahkh committed Jun 15, 2021
1 parent 6a7171b commit 235d1c9
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 88 deletions.
3 changes: 0 additions & 3 deletions tools/testing/selftests/sgx/load.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -239,9 +239,6 @@ bool encl_load(const char *path, struct encl *encl)
seg->offset = (phdr->p_offset & PAGE_MASK) - src_offset;
seg->size = (phdr->p_filesz + PAGE_SIZE - 1) & PAGE_MASK;

printf("0x%016lx 0x%016lx 0x%02x\n", seg->offset, seg->size,
seg->prot);

j++;
}

Expand Down
177 changes: 92 additions & 85 deletions tools/testing/selftests/sgx/main.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
#include <sys/types.h>
#include <sys/auxv.h>
#include "defines.h"
#include "../kselftest_harness.h"
#include "main.h"
#include "../kselftest.h"

static const uint64_t MAGIC = 0x1122334455667788ULL;
vdso_sgx_enter_enclave_t vdso_sgx_enter_enclave;
Expand Down Expand Up @@ -107,85 +107,49 @@ static Elf64_Sym *vdso_symtab_get(struct vdso_symtab *symtab, const char *name)
return NULL;
}

bool report_results(struct sgx_enclave_run *run, int ret, uint64_t result,
const char *test)
{
bool valid = true;

if (ret) {
printf("FAIL: %s() returned: %d\n", test, ret);
valid = false;
}

if (run->function != EEXIT) {
printf("FAIL: %s() function, expected: %u, got: %u\n", test, EEXIT,
run->function);
valid = false;
}

if (result != MAGIC) {
printf("FAIL: %s(), expected: 0x%lx, got: 0x%lx\n", test, MAGIC,
result);
valid = false;
}

if (run->user_data) {
printf("FAIL: %s() user data, expected: 0x0, got: 0x%llx\n",
test, run->user_data);
valid = false;
}

return valid;
}

static int user_handler(long rdi, long rsi, long rdx, long ursp, long r8, long r9,
struct sgx_enclave_run *run)
{
run->user_data = 0;
return 0;
}
FIXTURE(enclave) {
struct encl encl;
struct sgx_enclave_run run;
};

int main(int argc, char *argv[])
FIXTURE_SETUP(enclave)
{
struct sgx_enclave_run run;
Elf64_Sym *sgx_enter_enclave_sym = NULL;
struct vdso_symtab symtab;
Elf64_Sym *sgx_enter_enclave_sym;
uint64_t result = 0;
struct encl encl;
struct encl_segment *seg;
unsigned int i;
void *addr;
int ret;

memset(&run, 0, sizeof(run));

if (!encl_load("test_encl.elf", &encl)) {
encl_delete(&encl);
if (!encl_load("test_encl.elf", &self->encl)) {
encl_delete(&self->encl);
ksft_exit_skip("cannot load enclaves\n");
}

if (!encl_measure(&encl))
for (i = 0; i < self->encl.nr_segments; i++) {
seg = &self->encl.segment_tbl[i];

TH_LOG("0x%016lx 0x%016lx 0x%02x", seg->offset, seg->size, seg->prot);
}

if (!encl_measure(&self->encl))
goto err;

if (!encl_build(&encl))
if (!encl_build(&self->encl))
goto err;

/*
* An enclave consumer only must do this.
*/
for (i = 0; i < encl.nr_segments; i++) {
struct encl_segment *seg = &encl.segment_tbl[i];

addr = mmap((void *)encl.encl_base + seg->offset, seg->size,
seg->prot, MAP_SHARED | MAP_FIXED, encl.fd, 0);
if (addr == MAP_FAILED) {
perror("mmap() segment failed");
exit(KSFT_FAIL);
}
for (i = 0; i < self->encl.nr_segments; i++) {
struct encl_segment *seg = &self->encl.segment_tbl[i];

addr = mmap((void *)self->encl.encl_base + seg->offset, seg->size,
seg->prot, MAP_SHARED | MAP_FIXED, self->encl.fd, 0);
EXPECT_NE(addr, MAP_FAILED);
if (addr == MAP_FAILED)
goto err;
}

memset(&run, 0, sizeof(run));
run.tcs = encl.encl_base;

/* Get vDSO base address */
addr = (void *)getauxval(AT_SYSINFO_EHDR);
if (!addr)
Expand All @@ -200,32 +164,75 @@ int main(int argc, char *argv[])

vdso_sgx_enter_enclave = addr + sgx_enter_enclave_sym->st_value;

ret = sgx_enter_enclave((void *)&MAGIC, &result, 0, EENTER,
NULL, NULL, &run);
if (!report_results(&run, ret, result, "sgx_enter_enclave_unclobbered"))
goto err;
memset(&self->run, 0, sizeof(self->run));
self->run.tcs = self->encl.encl_base;

err:
if (!sgx_enter_enclave_sym)
encl_delete(&self->encl);

/* Invoke the vDSO directly. */
result = 0;
ret = vdso_sgx_enter_enclave((unsigned long)&MAGIC, (unsigned long)&result,
0, EENTER, 0, 0, &run);
if (!report_results(&run, ret, result, "sgx_enter_enclave"))
goto err;
ASSERT_NE(sgx_enter_enclave_sym, NULL);
}

/* And with an exit handler. */
run.user_handler = (__u64)user_handler;
run.user_data = 0xdeadbeef;
ret = vdso_sgx_enter_enclave((unsigned long)&MAGIC, (unsigned long)&result,
0, EENTER, 0, 0, &run);
if (!report_results(&run, ret, result, "user_handler"))
goto err;
FIXTURE_TEARDOWN(enclave)
{
encl_delete(&self->encl);
}

printf("SUCCESS\n");
encl_delete(&encl);
exit(KSFT_PASS);
#define ENCL_CALL(in, out, run, clobbered) \
({ \
int ret; \
if ((clobbered)) \
ret = vdso_sgx_enter_enclave((unsigned long)(in), (unsigned long)(out), 0, \
EENTER, 0, 0, (run)); \
else \
ret = sgx_enter_enclave((void *)(in), (void *)(out), 0, EENTER, NULL, NULL, \
(run)); \
ret; \
})

TEST_F(enclave, unclobbered_vdso)
{
uint64_t result = 0;

err:
encl_delete(&encl);
exit(KSFT_FAIL);
EXPECT_EQ(ENCL_CALL(&MAGIC, &result, &self->run, false), 0);

EXPECT_EQ(result, MAGIC);
EXPECT_EQ(self->run.function, EEXIT);
EXPECT_EQ(self->run.user_data, 0);
}

TEST_F(enclave, clobbered_vdso)
{
uint64_t result = 0;

EXPECT_EQ(ENCL_CALL(&MAGIC, &result, &self->run, true), 0);

EXPECT_EQ(result, MAGIC);
EXPECT_EQ(self->run.function, EEXIT);
EXPECT_EQ(self->run.user_data, 0);
}

static int test_handler(long rdi, long rsi, long rdx, long ursp, long r8, long r9,
struct sgx_enclave_run *run)
{
run->user_data = 0;

return 0;
}

TEST_F(enclave, clobbered_vdso_and_user_function)
{
uint64_t result = 0;

self->run.user_handler = (__u64)test_handler;
self->run.user_data = 0xdeadbeef;

EXPECT_EQ(ENCL_CALL(&MAGIC, &result, &self->run, true), 0);

EXPECT_EQ(result, MAGIC);
EXPECT_EQ(self->run.function, EEXIT);
EXPECT_EQ(self->run.user_data, 0);
}

TEST_HARNESS_MAIN

0 comments on commit 235d1c9

Please sign in to comment.