2016-04-15 13:19:22 +00:00
|
|
|
/*
|
|
|
|
* \brief Region map interface
|
|
|
|
* \author Norman Feske
|
|
|
|
* \date 2006-05-15
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2017-02-20 12:23:52 +00:00
|
|
|
* Copyright (C) 2006-2017 Genode Labs GmbH
|
2016-04-15 13:19:22 +00:00
|
|
|
*
|
|
|
|
* This file is part of the Genode OS framework, which is distributed
|
2017-02-20 12:23:52 +00:00
|
|
|
* under the terms of the GNU Affero General Public License version 3.
|
2016-04-15 13:19:22 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _INCLUDE__REGION_MAP__REGION_MAP_H_
|
|
|
|
#define _INCLUDE__REGION_MAP__REGION_MAP_H_
|
|
|
|
|
2024-06-16 13:08:56 +00:00
|
|
|
#include <util/attempt.h>
|
2016-04-15 13:19:22 +00:00
|
|
|
#include <base/exception.h>
|
|
|
|
#include <base/stdint.h>
|
|
|
|
#include <base/signal.h>
|
Streamline exception types
This patch reduces the number of exception types by facilitating
globally defined exceptions for common usage patterns shared by most
services. In particular, RPC functions that demand a session-resource
upgrade not longer reflect this condition via a session-specific
exception but via the 'Out_of_ram' or 'Out_of_caps' types.
Furthermore, the 'Parent::Service_denied', 'Parent::Unavailable',
'Root::Invalid_args', 'Root::Unavailable', 'Service::Invalid_args',
'Service::Unavailable', and 'Local_service::Factory::Denied' types have
been replaced by the single 'Service_denied' exception type defined in
'session/session.h'.
This consolidation eases the error handling (there are fewer exceptions
to handle), alleviates the need to convert exceptions along the
session-creation call chain, and avoids possible aliasing problems
(catching the wrong type with the same name but living in a different
scope).
2017-05-07 20:03:22 +00:00
|
|
|
#include <base/quota_guard.h>
|
2016-04-15 13:19:22 +00:00
|
|
|
#include <dataspace/capability.h>
|
|
|
|
|
|
|
|
namespace Genode { struct Region_map; }
|
|
|
|
|
|
|
|
|
Follow practices suggested by "Effective C++"
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:
* A class with virtual functions can no longer publicly inherit base
classed without a vtable. The inherited object may either be moved
to a member variable, or inherited privately. The latter would be
used for classes that inherit 'List::Element' or 'Avl_node'. In order
to enable the 'List' and 'Avl_tree' to access the meta data, the
'List' must become a friend.
* Instead of adding a virtual destructor to abstract base classes,
we inherit the new 'Interface' class, which contains a virtual
destructor. This way, single-line abstract base classes can stay
as compact as they are now. The 'Interface' utility resides in
base/include/util/interface.h.
* With the new warnings enabled, all member variables must be explicitly
initialized. Basic types may be initialized with '='. All other types
are initialized with braces '{ ... }' or as class initializers. If
basic types and non-basic types appear in a row, it is nice to only
use the brace syntax (also for basic types) and align the braces.
* If a class contains pointers as members, it must now also provide a
copy constructor and assignment operator. In the most cases, one
would make them private, effectively disallowing the objects to be
copied. Unfortunately, this warning cannot be fixed be inheriting
our existing 'Noncopyable' class (the compiler fails to detect that
the inheriting class cannot be copied and still gives the error).
For now, we have to manually add declarations for both the copy
constructor and assignment operator as private class members. Those
declarations should be prepended with a comment like this:
/*
* Noncopyable
*/
Thread(Thread const &);
Thread &operator = (Thread const &);
In the future, we should revisit these places and try to replace
the pointers with references. In the presence of at least one
reference member, the compiler would no longer implicitly generate
a copy constructor. So we could remove the manual declaration.
Issue #465
2017-12-21 14:42:15 +00:00
|
|
|
struct Genode::Region_map : Interface
|
2016-04-15 13:19:22 +00:00
|
|
|
{
|
|
|
|
/**
|
2024-06-18 16:29:31 +00:00
|
|
|
* Fault state of region map
|
2016-04-15 13:19:22 +00:00
|
|
|
*
|
|
|
|
* If a thread accesses a location outside the regions attached to its
|
|
|
|
* address space, a fault occurs and gets signalled to the registered fault
|
|
|
|
* handler. The fault handler, in turn needs the information about the
|
|
|
|
* fault address and fault type to resolve the fault. This information is
|
|
|
|
* represented by this structure.
|
|
|
|
*/
|
2024-06-18 16:29:31 +00:00
|
|
|
struct Fault
|
2016-04-15 13:19:22 +00:00
|
|
|
{
|
2024-06-18 16:29:31 +00:00
|
|
|
enum class Type { NONE, READ, WRITE, EXEC };
|
|
|
|
|
|
|
|
Type type; /* type of occurred fault */
|
|
|
|
addr_t addr; /* fault address unless fault is 'NONE' */
|
2016-04-15 13:19:22 +00:00
|
|
|
};
|
|
|
|
|
2024-06-18 16:29:31 +00:00
|
|
|
struct Range { addr_t start; size_t num_bytes; };
|
2016-04-15 13:19:22 +00:00
|
|
|
|
|
|
|
/**
|
2024-06-18 16:29:31 +00:00
|
|
|
* Attributes for 'attach'
|
2016-04-15 13:19:22 +00:00
|
|
|
*/
|
2024-06-18 16:29:31 +00:00
|
|
|
struct Attr
|
2016-04-15 13:19:22 +00:00
|
|
|
{
|
2024-06-18 16:29:31 +00:00
|
|
|
size_t size; /* size of the mapping, or 0 for the whole dataspace */
|
|
|
|
addr_t offset; /* page-aligned offset in dataspace */
|
|
|
|
bool use_at;
|
|
|
|
addr_t at; /* designated start of region if 'use_at' is true */
|
|
|
|
bool executable;
|
|
|
|
bool writeable;
|
2016-04-15 13:19:22 +00:00
|
|
|
};
|
|
|
|
|
2024-06-18 16:29:31 +00:00
|
|
|
enum class Attach_error { OUT_OF_RAM, OUT_OF_CAPS, REGION_CONFLICT, INVALID_DATASPACE };
|
2016-04-15 13:19:22 +00:00
|
|
|
|
2024-06-18 16:29:31 +00:00
|
|
|
using Attach_result = Attempt<Range, Attach_error>;
|
2016-04-15 13:19:22 +00:00
|
|
|
|
|
|
|
/**
|
Streamline exception types
This patch reduces the number of exception types by facilitating
globally defined exceptions for common usage patterns shared by most
services. In particular, RPC functions that demand a session-resource
upgrade not longer reflect this condition via a session-specific
exception but via the 'Out_of_ram' or 'Out_of_caps' types.
Furthermore, the 'Parent::Service_denied', 'Parent::Unavailable',
'Root::Invalid_args', 'Root::Unavailable', 'Service::Invalid_args',
'Service::Unavailable', and 'Local_service::Factory::Denied' types have
been replaced by the single 'Service_denied' exception type defined in
'session/session.h'.
This consolidation eases the error handling (there are fewer exceptions
to handle), alleviates the need to convert exceptions along the
session-creation call chain, and avoids possible aliasing problems
(catching the wrong type with the same name but living in a different
scope).
2017-05-07 20:03:22 +00:00
|
|
|
* Map dataspace into region map
|
2016-04-15 13:19:22 +00:00
|
|
|
*
|
2024-06-18 16:29:31 +00:00
|
|
|
* \param ds capability of dataspace to map
|
|
|
|
* \param attr mapping attributes
|
|
|
|
* \return address range of mapping within region map
|
2023-06-09 23:12:30 +00:00
|
|
|
*/
|
2024-06-18 16:29:31 +00:00
|
|
|
virtual Attach_result attach(Dataspace_capability ds, Attr const &attr) = 0;
|
2016-04-15 13:19:22 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove region from local address space
|
|
|
|
*/
|
2024-06-18 16:29:31 +00:00
|
|
|
virtual void detach(addr_t) = 0;
|
2016-04-15 13:19:22 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Register signal handler for region-manager faults
|
|
|
|
*
|
|
|
|
* On Linux, this signal is never delivered because page-fault handling
|
|
|
|
* is performed by the Linux kernel. On microkernel platforms,
|
|
|
|
* unresolvable page faults (traditionally called segmentation fault)
|
|
|
|
* will result in the delivery of the signal.
|
|
|
|
*/
|
|
|
|
virtual void fault_handler(Signal_context_capability handler) = 0;
|
|
|
|
|
|
|
|
/**
|
2024-06-18 16:29:31 +00:00
|
|
|
* Request current fault state of region map
|
2016-04-15 13:19:22 +00:00
|
|
|
*/
|
2024-06-18 16:29:31 +00:00
|
|
|
virtual Fault fault() = 0;
|
2016-04-15 13:19:22 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Return dataspace representation of region map
|
|
|
|
*/
|
|
|
|
virtual Dataspace_capability dataspace() = 0;
|
|
|
|
|
|
|
|
|
|
|
|
/*********************
|
|
|
|
** RPC declaration **
|
|
|
|
*********************/
|
|
|
|
|
2024-06-18 16:29:31 +00:00
|
|
|
GENODE_RPC(Rpc_attach, Attach_result, attach, Dataspace_capability, Attr const &);
|
|
|
|
GENODE_RPC(Rpc_detach, void, detach, addr_t);
|
2016-04-15 13:19:22 +00:00
|
|
|
GENODE_RPC(Rpc_fault_handler, void, fault_handler, Signal_context_capability);
|
2024-06-18 16:29:31 +00:00
|
|
|
GENODE_RPC(Rpc_fault, Fault, fault);
|
2016-04-15 13:19:22 +00:00
|
|
|
GENODE_RPC(Rpc_dataspace, Dataspace_capability, dataspace);
|
|
|
|
|
2024-06-18 16:29:31 +00:00
|
|
|
GENODE_RPC_INTERFACE(Rpc_attach, Rpc_detach, Rpc_fault_handler, Rpc_fault,
|
2016-04-15 13:19:22 +00:00
|
|
|
Rpc_dataspace);
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* _INCLUDE__REGION_MAP__REGION_MAP_H_ */
|