Hi Volodymyr,
On 18/12/2018 21:11, Volodymyr Babchuk wrote:
From: Volodymyr Babchuk vlad.babchuk@gmail.com
Shared memory is widely used by NW to communicate with TAs in OP-TEE. NW can share part of own memory with TA or OP-TEE core, by registering it OP-TEE, or by providing a temporal reference. Anyways, information about such memory buffers are sent to OP-TEE as a list of pages. This mechanism is described in optee_msg.h.
Mediator should step in when NW tries to share memory with OP-TEE for two reasons:
- Do address translation from IPA to PA.
- Pin domain pages till they are mapped into OP-TEE or TA
Looking at the code, I think the page are mapped while OP-TEE is using them. If so, it should be s/till/while/.
address space, so domain can't transfer this pages to other domain or balloon out them. >Address translation is done by translate_noncontig(...) function. It allocates new buffer from xenheap and then walks on guest provided list of pages, translates addresses and stores PAs into newly allocated buffer. This buffer will be provided to OP-TEE instead of original buffer from the guest. This buffer will be free at the end of standard call.
In the same time this function pins pages and stores them in struct optee_shm_buf object. This object will live all the time, when given SHM buffer is known to OP-TEE. It will be freed after guest unregisters shared buffer. At this time pages will be unpinned.
We don't need to do any special reference counting because OP-TEE tracks buffer on its side. So, mediator will unpin pages only when OP-TEE returns successfully from OPTEE_MSG_CMD_UNREGISTER_SHM call.
Signed-off-by: Volodymyr Babchuk vlad.babchuk@gmail.com
Changes from v2:
- Made sure that guest does not tries to register shared buffer with the same cookie twice
- Fixed coding style
- Use access_guest_memory_by_ipa() instead of direct memory mapping
xen/arch/arm/tee/optee.c | 274 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 274 insertions(+)
diff --git a/xen/arch/arm/tee/optee.c b/xen/arch/arm/tee/optee.c index 771148e940..cfc3b34df7 100644 --- a/xen/arch/arm/tee/optee.c +++ b/xen/arch/arm/tee/optee.c @@ -37,6 +37,10 @@ */ #define MAX_RPC_SHMS MAX_STD_CALLS +/* Maximum total number of pages that guest can share with OP-TEE */ +#define MAX_TOTAL_SMH_BUF_PG 16384
Please explain in the commit message and code how you came up to this value.
+#define MAX_NONCONTIG_ENTRIES 5
If I understand correctly the code below, MAX_NONCONTIG_ENTIRES is basically linked to the number of parameters. The maximum number of parameters is 5.
I see in patch #6 you check have the following check
OPTEE_MSG_GET_ARG_SIZE(num_params) > OPTEE_MSG_NONCONTIG_PAGE_SIZE
It is not entirely obvious how this ensure you have no more than 5 parameters neither how you came up to this value. Can you please at least provide more documentation in the code explaining the origin of the value?
You might also want a
BUILD_BUG_ON(OPTEE_MSG_GET_ARG_SIZE(MAX_NONCONTIG_ENTRIES) == OPTEE_MSG_NONCONTIG_PAGE_SIZE).
- #define OPTEE_KNOWN_NSEC_CAPS OPTEE_SMC_NSEC_CAP_UNIPROCESSOR #define OPTEE_KNOWN_SEC_CAPS (OPTEE_SMC_SEC_CAP_HAVE_RESERVED_SHM | \ OPTEE_SMC_SEC_CAP_UNREGISTERED_SHM | \
@@ -50,6 +54,9 @@ struct optee_std_call { struct list_head list; struct optee_msg_arg *xen_arg; paddr_t guest_arg_ipa;
- /* Buffer for translated page addresses, shared with OP-TEE */
- void *non_contig[MAX_NONCONTIG_ENTRIES];
- int non_contig_order[MAX_NONCONTIG_ENTRIES]; int optee_thread_id; int rpc_op; bool in_flight;
@@ -63,12 +70,23 @@ struct shm_rpc { uint64_t cookie; }; +/* Shared memory buffer for arbitrary data */ +struct optee_shm_buf {
- struct list_head list;
- uint64_t cookie;
- unsigned int max_page_cnt;
- unsigned int page_cnt;
I am not convinced the two variables are useful. It actually adds more confusion because of the close naming.
Looking at the code, you add the page contiguously in the array. So I think page_cnt could easily be replaced by checking whether pages[N] is NULL .
- struct page_info *pages[];
+};
- /* Domain context */ struct optee_domain { struct list_head call_list; struct list_head shm_rpc_list;
- struct list_head optee_shm_buf_list; atomic_t call_count; atomic_t shm_rpc_count;
- atomic_t optee_shm_buf_pages; spinlock_t lock; };
@@ -125,9 +143,11 @@ static int optee_enable(struct domain *d) INIT_LIST_HEAD(&ctx->call_list); INIT_LIST_HEAD(&ctx->shm_rpc_list);
- INIT_LIST_HEAD(&ctx->optee_shm_buf_list);
atomic_set(&ctx->call_count, 0); atomic_set(&ctx->shm_rpc_count, 0);
- atomic_set(&ctx->optee_shm_buf_pages, 0);
spin_lock_init(&ctx->lock); @@ -325,12 +345,91 @@ static void free_shm_rpc(struct optee_domain *ctx, uint64_t cookie) xfree(shm_rpc); } +static struct optee_shm_buf *allocate_optee_shm_buf(struct optee_domain *ctx,
uint64_t cookie,unsigned int pages_cnt)+{
- struct optee_shm_buf *optee_shm_buf, *optee_shm_buf_tmp;
- while ( true )
I would prefer if we avoid while ( true ) and use
do { } while ( atomic...(...) != old)
- {
int old = atomic_read(&ctx->optee_shm_buf_pages);int new = old + pages_cnt;
Newline here please.
if ( new >= MAX_TOTAL_SMH_BUF_PG )return NULL;
The limitation is in number of page and quite high. What would prevent a guest to register shared memory page by page? If nothing, then I think you can end up to something interesting issue in Xen because of the growing list and memory used.
if ( likely(old == atomic_cmpxchg(&ctx->optee_shm_buf_pages,old, new)) )break;- }
- optee_shm_buf = xzalloc_bytes(sizeof(struct optee_shm_buf) +
pages_cnt * sizeof(struct page *));
Coding style: page_cnt should be aligned with sizeof.
- if ( !optee_shm_buf )
goto err;- optee_shm_buf->cookie = cookie;
- optee_shm_buf->max_page_cnt = pages_cnt;
- spin_lock(&ctx->lock);
- /* Check if there is already SHM with the same cookie */
- list_for_each_entry( optee_shm_buf_tmp, &ctx->optee_shm_buf_list, list )
- {
if ( optee_shm_buf_tmp->cookie == cookie ){spin_unlock(&ctx->lock);gprintk(XENLOG_WARNING, "Guest tries to use the same SHM buffer cookie");
I would use gdprintk(...) and add the cookie number for debug.
goto err;}- }
- list_add_tail(&optee_shm_buf->list, &ctx->optee_shm_buf_list);
- spin_unlock(&ctx->lock);
- return optee_shm_buf;
+err:
- atomic_sub(pages_cnt, &ctx->optee_shm_buf_pages);
- xfree(optee_shm_buf);
- return NULL;
+}
+static void free_optee_shm_buf(struct optee_domain *ctx, uint64_t cookie) +{
- struct optee_shm_buf *optee_shm_buf;
- bool found = false;
- spin_lock(&ctx->lock);
- list_for_each_entry( optee_shm_buf, &ctx->optee_shm_buf_list, list )
- {
if ( optee_shm_buf->cookie == cookie ){found = true;list_del(&optee_shm_buf->list);break;}- }
- spin_unlock(&ctx->lock);
- if ( !found )
return;- for ( int i = 0; i < optee_shm_buf->page_cnt; i++ )
The variable should be declared at the beginning of the function. It should also be unsigned.
if ( optee_shm_buf->pages[i] )put_page(optee_shm_buf->pages[i]);- atomic_sub(optee_shm_buf->max_page_cnt, &ctx->optee_shm_buf_pages);
- xfree(optee_shm_buf);
+}
- static void optee_domain_destroy(struct domain *d) { struct arm_smccc_res resp; struct optee_std_call *call, *call_tmp; struct optee_domain *ctx = d->arch.tee; struct shm_rpc *shm_rpc, *shm_rpc_tmp;
- struct optee_shm_buf *optee_shm_buf, *optee_shm_buf_tmp;
/* At this time all domain VCPUs should be stopped */ @@ -349,12 +448,177 @@ static void optee_domain_destroy(struct domain *d) list_for_each_entry_safe( shm_rpc, shm_rpc_tmp, &ctx->shm_rpc_list, list ) free_shm_rpc(ctx, shm_rpc->cookie);
- list_for_each_entry_safe( optee_shm_buf, optee_shm_buf_tmp,
&ctx->optee_shm_buf_list, list )free_optee_shm_buf(ctx, optee_shm_buf->cookie);ASSERT(!atomic_read(&ctx->call_count)); ASSERT(!atomic_read(&ctx->shm_rpc_count));- ASSERT(!atomic_read(&ctx->optee_shm_buf_pages));
xfree(d->arch.tee); } +#define PAGELIST_ENTRIES_PER_PAGE \
- ((OPTEE_MSG_NONCONTIG_PAGE_SIZE / sizeof(u64)) - 1)
+static size_t get_pages_list_size(size_t num_entries) +{
- int pages = DIV_ROUND_UP(num_entries, PAGELIST_ENTRIES_PER_PAGE);
- return pages * OPTEE_MSG_NONCONTIG_PAGE_SIZE;
+}
+static bool translate_noncontig(struct optee_domain *ctx,
struct optee_std_call *call,struct optee_msg_param *param,int idx)
The parameter idx should be unsigned int.
+{
- /*
* Refer to OPTEE_MSG_ATTR_NONCONTIG description in optee_msg.h for details.*/- uint64_t size;
- unsigned int page_offset;
- unsigned int num_pages;
- unsigned int order;
- unsigned int entries_on_page = 0;
- paddr_t gaddr;
By the way you use this variable, I would prefer if you store a frame using gfn_t.
- struct page_info *guest_page;
- struct {
uint64_t pages_list[PAGELIST_ENTRIES_PER_PAGE];uint64_t next_page_data;- } *pages_data_guest, *pages_data_xen, *pages_data_xen_start;
The structure is the internal of OPTEE_MSG_ATTR_NONCONTIG, am I correct? If so, the comment at the beginning of the function should be on top of the structure with further clarification (i.e this is the layout of the memory).
- struct optee_shm_buf *optee_shm_buf;
- /* Offset of user buffer withing page */
NIT: s/withing/within/
- page_offset = param->u.tmem.buf_ptr & (OPTEE_MSG_NONCONTIG_PAGE_SIZE - 1);
- /* Size of the user buffer in bytes */
- size = ROUNDUP(param->u.tmem.size + page_offset,
OPTEE_MSG_NONCONTIG_PAGE_SIZE);- num_pages = DIV_ROUND_UP(size, OPTEE_MSG_NONCONTIG_PAGE_SIZE);
- order = get_order_from_bytes(get_pages_list_size(num_pages));
- pages_data_xen_start = alloc_xenheap_pages(order, 0);
By using alloc_xenheap_pages, you may end-up allocation more memory than necessary when the order is getting bigger. What is the bigger order you expect here?
[...]
/*
- Copy command buffer into xen memory to:
- Hide translated addresses from guest
@@ -469,6 +733,14 @@ static void execute_std_call(struct optee_domain *ctx, copy_std_request_back(ctx, regs, call);
- /*
* If guest successfully unregistered own shared memory,* then we can unpin it's pages
NIT: Missing full stop.
*/- if ( call->xen_arg->cmd == OPTEE_MSG_CMD_UNREGISTER_SHM &&
call->xen_arg->ret == 0 )free_optee_shm_buf(ctx, call->xen_arg->params[0].u.rmem.shm_ref);put_std_call(ctx, call); free_std_call(ctx, call);
Cheers,