genode/repos/base-sel4/src/core/include/kernel_object.h
Norman Feske 9e6f3be806 sel4: update to version 2.1
This patch updates seL4 from the experimental branch of one year ago to
the master branch of version 2.1. The transition has the following
implications.

In contrast to the experimental branch, the master branch has no way to
manually define the allocation of kernel objects within untyped memory
ranges. Instead, the kernel maintains a built-in allocation policy. This
policy rules out the deallocation of once-used parts of untyped memory.
The only way to reuse memory is to revoke the entire untyped memory
range. Consequently, we cannot share a large untyped memory range for
kernel objects of different protection domains. In order to reuse memory
at a reasonably fine granularity, we need to split the initial untyped
memory ranges into small chunks that can be individually revoked. Those
chunks are called "untyped pages". An untyped page is a 4 KiB untyped
memory region.

The bootstrapping of core has to employ a two-stage allocation approach
now. For creating the initial kernel objects for core, which remain
static during the entire lifetime of the system, kernel objects are
created directly out of the initial untyped memory regions as reported
by the kernel. The so-called "initial untyped pool" keeps track of the
consumption of those untyped memory ranges by mimicking the kernel's
internal allocation policy. Kernel objects created this way can be of
any size. For example the phys CNode, which is used to store page-frame
capabilities is 16 MiB in size. Also, core's CSpace uses a relatively
large CNode.

After the initial setup phase, all remaining untyped memory is turned
into untyped pages. From this point on, new created kernel objects
cannot exceed 4 KiB in size because one kernel object cannot span
multiple untyped memory regions. The capability selectors for untyped
pages are organized similarly to those of page-frame capabilities. There
is a new 2nd-level CNode (UNTYPED_CORE_CNODE) that is dimensioned
according to the maximum amount of physical memory (1M entries, each
entry representing 4 KiB). The CNode is organized such that an index
into the CNode directly corresponds to the physical frame number of the
underlying memory. This way, we can easily determine a untyped page
selector for any physical addresses, i.e., for revoking the kernel
objects allocated at a specific physical page. The downside is the need
for another 16 MiB chunk of meta data. Also, we need to keep in mind
that this approach won't scale to 64-bit systems. We will eventually
need to replace the PHYS_CORE_CNODE and UNTYPED_CORE_CNODE by CNode
hierarchies to model a sparsely populated CNode.

The size constrain of kernel objects has the immediate implication that
the VM CSpaces of protection domains must be organized via several
levels of CNodes. I.e., as the top-level CNode of core has a size of
2^12, the remaining 20 PD-specific CSpace address bits are organized as
a 2nd-level 2^4 padding CNode, a 3rd-level 2^8 CNode, and several
4th-level 2^8 leaf CNodes. The latter contain the actual selectors for
the page tables and page-table entries of the respective PD.

As another slight difference from the experimental branch, the master
branch requires the explicit assignment of page directories to an ASID
pool.

Besides the adjustment to the new seL4 version, the patch introduces a
dedicated type for capability selectors. Previously, we just used to
represent them as unsigned integer values, which became increasingly
confusing. The new type 'Cap_sel' is a PD-local capability selector. The
type 'Cnode_index' is an index into a CNode (which is not generally not
the entire CSpace of the PD).

Fixes #1887
2016-02-26 11:36:55 +01:00

190 lines
5.7 KiB
C++

/*
* \brief Utilities for creating seL4 kernel objects
* \author Norman Feske
* \date 2015-05-08
*/
/*
* Copyright (C) 2015 Genode Labs GmbH
*
* This file is part of the Genode OS framework, which is distributed
* under the terms of the GNU General Public License version 2.
*/
#ifndef _CORE__INCLUDE__KERNEL_OBJECT_H_
#define _CORE__INCLUDE__KERNEL_OBJECT_H_
/* Genode includes */
#include <base/exception.h>
/* core includes */
#include <untyped_memory.h>
#include <initial_untyped_pool.h>
namespace Genode {
/**
* Index referring to a slot in a CNode
*/
struct Cnode_index : Cap_sel
{
explicit Cnode_index(addr_t value) : Cap_sel(value) { }
Cnode_index(Cap_sel sel) : Cap_sel(sel.value()) { }
};
struct Tcb_kobj
{
enum { SEL4_TYPE = seL4_TCBObject, SIZE_LOG2 = 12 };
static char const *name() { return "TCB"; }
};
struct Endpoint_kobj
{
enum { SEL4_TYPE = seL4_EndpointObject, SIZE_LOG2 = 4 };
static char const *name() { return "endpoint"; }
};
struct Cnode_kobj
{
enum { SEL4_TYPE = seL4_CapTableObject, SIZE_LOG2 = 4 };
static char const *name() { return "cnode"; }
};
struct Page_table_kobj
{
enum { SEL4_TYPE = seL4_IA32_PageTableObject, SIZE_LOG2 = 12 };
static char const *name() { return "page table"; }
};
struct Page_directory_kobj
{
enum { SEL4_TYPE = seL4_IA32_PageDirectoryObject, SIZE_LOG2 = 12 };
static char const *name() { return "page directory"; }
};
struct Retype_untyped_failed : Genode::Exception { };
/**
* Create kernel object from untyped memory
*
* \param KOBJ kernel-object description
* \param phys_alloc allocator for untyped memory
* \param dst_cnode_sel CNode selector where to store the cap pointing to
* the new kernel object
* \param dst_idx designated index of cap selector within 'dst_cnode'
* \param size_log2 size of kernel object in bits, only needed for
* variable-sized objects like CNodes
*
* \return physical address of created kernel object
*
* \throw Phys_alloc_failed
* \throw Retype_untyped_failed
*
* The kernel-object description is a policy type that contains enum
* definitions for 'SEL4_TYPE' and 'SIZE_LOG2', and a static function
* 'name' that returns the type name as a char const pointer.
*
* XXX to be removed
*/
template <typename KOBJ>
static addr_t create(Range_allocator &phys_alloc,
Cap_sel dst_cnode_sel,
Cnode_index dst_idx,
size_t size_log2 = 0)
{
/* allocate physical page */
addr_t phys_addr = Untyped_memory::alloc_page(phys_alloc);
seL4_Untyped const service = Untyped_memory::untyped_sel(phys_addr).value();
int const type = KOBJ::SEL4_TYPE;
int const size_bits = size_log2;
seL4_CNode const root = dst_cnode_sel.value();
int const node_index = 0;
int const node_depth = 0;
int const node_offset = dst_idx.value();
int const num_objects = 1;
int const ret = seL4_Untyped_Retype(service,
type,
size_bits,
root,
node_index,
node_depth,
node_offset,
num_objects);
if (ret != 0) {
PERR("seL4_Untyped_RetypeAtOffset (%s) returned %d",
KOBJ::name(), ret);
throw Retype_untyped_failed();
}
PLOG("created kernel object '%s' at 0x%lx -> root=%lu index=%lu",
KOBJ::name(), phys_addr, dst_cnode_sel.value(), dst_idx.value());
return phys_addr;
}
/**
* Create kernel object from initial untyped memory pool
*
* \param KOBJ kernel-object description
* \param untyped_pool initial untyped memory pool
* \param dst_cnode_sel CNode selector where to store the cap pointing to
* the new kernel object
* \param dst_idx designated index of cap selector within 'dst_cnode'
* \param size_log2 size of kernel object in bits, only needed for
* variable-sized objects like CNodes
*
* \throw Initial_untyped_pool::Initial_untyped_pool_exhausted
* \throw Retype_untyped_failed
*
* The kernel-object description is a policy type that contains enum
* definitions for 'SEL4_TYPE' and 'SIZE_LOG2', and a static function
* 'name' that returns the type name as a char const pointer.
*/
template <typename KOBJ>
static void create(Initial_untyped_pool &untyped_pool,
Cap_sel dst_cnode_sel,
Cnode_index dst_idx,
size_t size_log2 = 0)
{
unsigned const sel = untyped_pool.alloc(KOBJ::SIZE_LOG2 + size_log2);
seL4_Untyped const service = sel;
int const type = KOBJ::SEL4_TYPE;
int const size_bits = size_log2;
seL4_CNode const root = dst_cnode_sel.value();
int const node_index = 0;
int const node_depth = 0;
int const node_offset = dst_idx.value();
int const num_objects = 1;
int const ret = seL4_Untyped_Retype(service,
type,
size_bits,
root,
node_index,
node_depth,
node_offset,
num_objects);
if (ret != 0) {
PERR("seL4_Untyped_Retype (%s) returned %d",
KOBJ::name(), ret);
throw Retype_untyped_failed();
}
}
};
#endif /* _CORE__INCLUDE__KERNEL_OBJECT_H_ */